Payouts
Represents payouts of funds to a bank account or debit card, including amount, status, destination, and reconciliation details.
Table-Specific Information
SELECT
The add-in uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
| Column | Supported Operators |
| Id | = |
| Destination | = |
| Status | = |
| AccountId | = |
| ArrivalDate | <, <=, =, >, >= |
| Created | <, <=, =, >, >= |
You can select from the Payouts table with the following queries:
SELECT * FROM Payouts WHERE Status = 'paid'
SELECT * FROM Payouts WHERE Destination = 'ba_1LylJA2eZvKYlo2CFndhyBc6'
SELECT * FROM Payouts WHERE Created > '2024-01-01'
SELECT * FROM Payouts WHERE ArrivalDate < '2024-08-01'
SELECT * FROM Payouts WHERE Status = 'failed'
INSERT
To create a new payout amount, Currency is required. The columns that are not read-only can be inserted optionally.
INSERT INTO Payouts (amount, currency, description, Metadata, StatementDescriptor, Destination, `Method`, sourcetype) VALUES ('20', 'usd', 'Weekly commision payout', '[{"order_id":"15426"}]', 'Commission Payment', 'ba_1LylJA2eZvKYlo2CFndhyBc6', 'standard', 'bitcoin_receiver' )
UPDATE
Update can be executed by specifying Id. The columns that are not read-only can be updated optionally.
UPDATE Payouts SET Metadata = '[{\"order_id\":\"25869633\"}]' WHERE Id = 'po_1OPRUn2eZvKYlo2COA33LQ2S'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The Id of the payout. | |
| Object | String | True |
The string representing the type of the object. | |
| Amount | Integer | False |
The amount, in cents, to be transferred to the bank account or debit card. | |
| ArrivalDate | Datetime | True |
The date the payout is expected to arrive in the bank. | |
| BalanceTransaction | String | True |
The Id of the balance transaction that describes the impact of this payout on the account balance. | |
| Created | Datetime | True |
The time at which the payout was created. | |
| Currency | String | False |
Three-letter ISO currency code. | |
| Description | String | False |
The payout description. | |
| Destination | String | False |
Accounts.Id |
The Id of the bank account or card the payout was sent to. |
| FailureBalanceTransaction | String | True |
If the payout failed or was canceled, this is the Id of the balance transaction that reversed the initial balance transaction. | |
| FailureCode | String | True |
The error code explaining the reason for the payout failure, if available. | |
| FailureMessage | String | True |
The message explaining the reason for the payout failure, if available. | |
| Metadata | String | False |
Set of key/value pairs that you can attach to an object. | |
| Method | String | False |
The method used to send this payout. The instant method is only supported for payouts to debit cards. The allowed values are standard, instant. | |
| SourceType | String | False |
The source balance this payout came from. The allowed values are card, bank_account, bitcoin_receiver, alipay_account, fpx. | |
| StatementDescriptor | String | False |
Extra information about a payout to be displayed on the bank statement. | |
| Status | String | True |
Current status of the payout. The allowed values are paid, pending, in_transit, canceled, failed. | |
| Type | String | True |
The destination type for the payout, such as bank_account or card. The allowed values are bank_account, card. | |
| Automatic | Boolean | True |
Indicates whether the payout was created by an automated payout schedule, as opposed to being requested manually. | |
| Livemode | Boolean | True |
Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| OriginalPayout | String | True |
If the payout reverses another, this is the Id of the original payout. | |
| ReversedBy | String | True |
If the payout was reversed, this is the Id of the payout that reverses this payout. | |
| ReconciliationStatus | String | True |
If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. The allowed values are completed, in_progress, not_applicable. | |
| TraceIdStatus | String | True |
When payout.status is pending or in_transit, this will be pending. When the payout transitions to paid, failed, or canceled, this status will become supported or unsupported shortly after in most cases. In some cases, this may appear as pending for up to 10 days after arrival_date until transitioning to supported or unsupported. The allowed values are pending, supported, unsupported. | |
| TraceIdValue | String | True |
The trace Id value if trace_id.status is supported, otherwise nil. | |
| ApplicationFee | String | True |
The Id of the application fee (if any) for this payout. | |
| ApplicationFeeAmount | Integer | True |
The amount of the application fee (if any) for this payout. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| AccountId | String |
The Id of the connected account for which to retrieve payouts. |