Payouts

Query the available Payouts in Stripe.

Table Specific Information

Select

Server-Side Query Support

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.

Id supports the following operators: =.
Destination supports the following operators: =.
Status supports the following operators: =.
AccountId supports the following operators: =.
ArrivalDate and Created support the following operators: <, <=, =, >, >=.

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'

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 Currency = 'usd'
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		String representing the type of the object.
Amount	Integer	False		Amount (in cents) to be transferred to the bank account or debit card.
ArrivalDate	Datetime	True		Date the payout is expected to arrive in the bank. .
BalanceTransaction	String	True	BalanceTransactions.Id	The Id of the balance transaction that describes the impact of this payout on the account balance.
Created	Datetime	True		Time of creation.
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 will be the ID of the balance transaction that reversed the initial balance transaction.
FailureCode	String	True		Error code explaining reason for payout failure if available.
FailureMessage	String	True		Error code explaining reason for payout failure if available.
Metadata	String	False		Set of key/value pairs that you can attach to an object.
Method	String	False		TThe method used to send this payout. instant 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		Can be bank_account or card. The allowed values are bank_account, card.
Automatic	Boolean	True		Returns true if the payout was created by an automated payout schedule, and false if it was 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.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AccountId	String	The Id of the connected account to get payouts for

Excel Add-In for Stripe