Payouts

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.

Livemode

String

True

Flag indicating whether the object exists in live mode or test mode.

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.

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.

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

Last updated