Interface Payout

Export

Payout

Hierarchy

  • Payout

Properties

account_id: string

Memberof

Payout

amount: number

Amount to be transferred to your bank account, in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

Memberof

Payout

balance_transaction: BalanceTransaction

The balance transaction that describes the impact of this payout on your account balance. Note: Multiple balance transactions may be associated with this resource and you can fetch them all with /balance-transactions?source_id={id}.

Memberof

Payout

Deprecated

created_at: string

Time at which the object was created.

Memberof

Payout

currency: PayoutCurrency

Three-letter ISO currency code, in lowercase.

Memberof

Payout

description?: string

An arbitrary string attached to the object. Often useful for displaying to users.

Memberof

Payout

failure_code?: PayoutFailureCode

Error code explaining the reason for a payout failure, if available.

Memberof

Payout

id: string

Unique identifier for the object.

Memberof

Payout

paid_at?: string

The date the payout was paid.

Memberof

Payout

status: PayoutStatus

Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). Some failed payouts may initially show as paid but then change to failed.

Memberof

Payout

transaction_count?: number

An optional property that is included when specified in a query parameter on request. It represents the number of balance_transaction objects associated with the payout (aside from the payout balance transaction itself).

Memberof

Payout

updated_at: string

Time at which the object was last updated.

Memberof

Payout

Generated using TypeDoc