List Payouts

200

successful

Response body

object

data

array of objects

data

object

uuid

The unique identifier for the payout.

created_at

date-time

The date the payout was created. The date uses UTC and is represented in the iso8601 format.

failed_at

date-time | null

The date the payout failed. The date uses UTC and is represented in the iso8601 format.

gross_payout_amount_cents

integer

The gross amount of the payout before fees. The value is represented in cents.

gross_payout_amount_currency

string

The three letter ISO-4217 currency code of the gross payout amount.

installment_id

uuid

The unique identifier of the installment associated with this payout

installment_plan_id

uuid

The unique identifier of the installment plan associated with this payout

invoice_id

uuid

The unique identifier of the invoice associated with this payout

net_payout_amount_cents

integer

The net amount of the payout after fees. If there are no fees, this can be the same as gross payout amount. The value is represented in cents.

net_payout_amount_currency

string

The three letter ISO-4217 currency code of the net payout amount.

paid_at

date-time | null

The time at which the payout was successfully transferred to the destination account. The date uses UTC and is represented in the iso8601 format.

payable_account

object

The destination account of the payout.

paying_at

date-time | null

The time at which the payout was initiated. The date uses UTC and is represented in the iso8601 format.

payout_type

string

The type of payout

full_premium commission take_rate supplier

program_id

uuid

The unique identifier of the program associated with this payout

quote_id

uuid | null

The unique identifier of the quote associated with this payout

recipient

object

The entity receiving the payout funds.

reference

string

The reference number of the batch payout associated with this payout

status

string

The state of the payout

unpaid transferred paying paid failed skipped refunded pending_servicer_payment

subscription_id

uuid

deprecated

The unique identifier of the installment plan associated with this payout

updated_at

date-time

The date the payout was last updated. The date uses UTC and is represented in the iso8601 format.

200successful