Payouts
Retrieves a list of all payouts for the default location.
Table Specific Information
Select
The component uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the component.
- Status supports the following operators: =.
- CreatedAt supports the following operators: =, >=, <=, >, <.
- LocationId supports the following operators: =.
Retrieve the list of all payouts for the default location:
SELECT * FROM Payouts
Columns
| Name | Type | Description |
| Id [KEY] | String | A unique Id for the payout. |
| Status | String | The status for the payout.
The allowed values are SENT, FAILED, PAID. |
| LocationId | String | The Id of the location associated with the payout. |
| CreatedAt | Datetime | The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format. |
| UpdatedAt | Datetime | The timestamp of when the payout was last updated, in RFC 3339 format. |
| AmountMoneyAmount | String | The amount of money, in the smallest denomination of the currency indicated by currency. |
| AmountMoneyCurrencyCode | String | The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD. |
| DestinationId | String | Square issued unique Id (also known as the instrument ID) associated with this destination. |
| DestinationType | String | Type of the destination such as a bank account or debit card.
The allowed values are BANK_ACCOUNT, CARD, SQUARE_BALANCE, SQUARE_STORED_BALANCE. |
| Version | Int64 | The version number, which is incremented each time an update is made to this payout record. The version number helps developers receive event notifications or feeds out of order. |
| Type | String | Indicates the payout type.
The allowed values are SIMPLE, BATCH. |
| PayoutFeeAmount | String | The money amount of the payout fee. |
| PayoutFeeCurrencyCode | String | The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD. |
| PayoutFeeEffectiveAt | Datetime | The timestamp of when the fee takes effect, in RFC 3339 format. |
| PayoutFeeType | String | The type of fee assessed as part of the payout. |
| ArrivalDate | Date | The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination. |
| EndToEndId | String | A unique Id for each Payout object that might also appear on the seller’s bank statement. |