Square

GetBankAccount

Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/BankAccount) linked to a Square account.

GetBankAccountByV1Id

Returns details of a [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/BankAccount) identified by V1 bank account ID.

GetBreakType

Returns a single `BreakType` specified by `id`.

GetDeviceCode

Retrieves DeviceCode with the associated ID.

GetEmployeeWage

Returns a single `EmployeeWage` specified by `id`.

GetInvoice

Retrieves an invoice by invoice ID.

GetPayment

Retrieves details for a specific payment.

GetPaymentRefund

Retrieves a specific refund using the `refund_id`.

GetShift

Returns a single `Shift` specified by `id`.

GetTeamMemberWage

Returns a single `TeamMemberWage` specified by `id `.

GetTerminalCheckout

Retrieves a Terminal checkout request by `checkout_id`.

GetTerminalRefund

Retrieves an Interac Terminal refund object by ID.

ListBankAccounts

Returns a list of [BankAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/BankAccount) objects linked to a Square account.

ListBreakTypes

Returns a paginated list of `BreakType` instances for a business.

ListCards

Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returned.

ListCashDrawerShiftEvents

Provides a paginated list of events for a single cash drawer shift.

ListCatalog

Returns a list of [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject)s that includes all objects of a set of desired types (for example, all [CatalogItem](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItem) and [CatalogTax](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogTax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use [SearchCatalogObjects](https://developer.squareup.com/reference/square_2021-08-18/catalog-api/search-catalog-objects) and set the `include_deleted_objects` attribute value to `true`.

ListCustomerGroups

Retrieves the list of customer groups of a business.

ListCustomers

Lists customer profiles associated with a Square account. Under normal operating conditions, newly created or updated customer profiles become available for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated profiles can take closer to one minute or longer, especially during network incidents and outages.

ListCustomerSegments

Retrieves the list of customer segments of a business.

ListDeviceCodes

Lists all DeviceCodes associated with the merchant.

ListDisputeEvidence

Returns a list of evidence associated with a dispute.

ListDisputes

Returns a list of disputes associated with a particular account.

ListEmployeeRoles

Provides summary information for all of a business's employee roles.

ListEmployees

ListEmployeeWages

Returns a paginated list of `EmployeeWage` instances for a business.

ListGiftCards

Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards.

ListInvoices

Returns a list of invoices for a given location. The response is paginated. If truncated, the response includes a `cursor` that you use in a subsequent request to retrieve the next set of invoices.

ListLocations

Provides information of all locations of a business. Many Square API endpoints require a `location_id` parameter. The `id` field of the [`Location`](https://developer.squareup.com/reference/square_2021-08-18/objects/Location) objects returned by this endpoint correspond to that `location_id` parameter.

ListLoyaltyPrograms

Returns a list of loyalty programs in the seller's account. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). Replaced with [RetrieveLoyaltyProgram](https://developer.squareup.com/reference/square_2021-08-18/loyalty-api/retrieve-loyalty-program) when used with the keyword `main`.

ListMerchants

Returns `Merchant` information for a given access token. If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted you access. If you know the merchant ID, you can also use the [RetrieveMerchant](https://developer.squareup.com/reference/square_2021-08-18/merchants-api/retrieve-merchant) endpoint to get the merchant information.

ListOrders

Provides summary information for a merchant's online store orders.

ListRefunds

Lists refunds for one of a business's locations. In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50

ListSites

Lists the Square Online sites that belong to a seller. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

ListSubscriptionEvents

Lists all events for a specific subscription. In the current implementation, only `START_SUBSCRIPTION` and `STOP_SUBSCRIPTION` (when the subscription was canceled) events are returned.

ListTeamMemberBookingProfiles

Lists booking profiles for team members.

ListTeamMemberWages

Returns a paginated list of `TeamMemberWage` instances for a business.

ListTransactions

Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50

ListWorkweekConfigs

Returns a list of `WorkweekConfig` instances for a business.

RetrieveBooking

Retrieves a booking.

RetrieveBusinessBookingProfile

Retrieves a seller's booking profile.

RetrieveCard

Retrieves details for a specific Card.

RetrieveCashDrawerShift

Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftEvents](https://developer.squareup.com/reference/square_2021-08-18/cash-drawers-api/list-cash-drawer-shift-events) for a list of cash drawer shift events.

RetrieveCatalogObject

Returns a single [CatalogItem](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItem) as a [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) based on the provided ID. The returned object includes all of the relevant [CatalogItem](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItem) information including: [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItemVariation) children, references to its [CatalogModifierList](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogModifierList) objects, and the ids of any [CatalogTax](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogTax) objects that apply to it.

RetrieveCustomer

Returns details for a single customer.

RetrieveCustomerGroup

Retrieves a specific customer group as identified by the `group_id` value.

RetrieveCustomerSegment

Retrieves a specific customer segment as identified by the `segment_id` value.

RetrieveDispute

Returns details about a specific dispute.

RetrieveDisputeEvidence

Returns the evidence metadata specified by the evidence ID in the request URL path You must maintain a copy of the evidence you upload if you want to reference it later. You cannot download the evidence after you upload it.

RetrieveEmployee

RetrieveEmployee

Provides the details for a single employee.

RetrieveEmployeeRole

Provides the details for a single employee role.

RetrieveGiftCard

Retrieves a gift card using its ID.

RetrieveInventoryAdjustment

Returns the [InventoryAdjustment](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryAdjustment) object with the provided `adjustment_id`.

RetrieveInventoryChanges

Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) at the requested [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location)s. You can achieve the same result by calling [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2021-08-18/inventory-api/batch-retrieve-inventory-changes) and having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint.

RetrieveInventoryCount

Retrieves the current calculated stock count for a given [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) at a given set of [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location)s. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.

RetrieveInventoryPhysicalCount

Returns the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryPhysicalCount) object with the provided `physical_count_id`.

RetrieveInventoryTransfer

Returns the [InventoryTransfer](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryTransfer) object with the provided `transfer_id`.

RetrieveLocation

Retrieves details of a location. You can specify "main" as the location ID to retrieve details of the main location.

RetrieveOrder

Retrieves an [Order](https://developer.squareup.com/reference/square_2021-08-18/objects/Order) by ID.