Sign in
payouts

Create Payout

post/v2/payouts/

Request body

paymentsstring[]
disputesstring[]
refundsstring[]
status'pending' | 'to_pay' | 'early' | 'sent' | 'paid' | 'failed' | 'error'

An enumeration.

datestring date
descriptionstring

Example request

{
  "payments": [
    "paym_yWYfCSzsUUhr9KwMv7vuLZHX"
  ],
  "disputes": [
    "dspt_yWYfCSzsUUhr9KwMv7vuLZHX"
  ],
  "refunds": [
    "refd_yWYfCSzsUUhr9KwMv7vuLZHX"
  ]
}

Response

Successful Response

idstring required
referencestring required
currencystring required
amountinteger required
feesinteger required
fees_vatinteger required
status'pending' | 'to_pay' | 'early' | 'sent' | 'paid' | 'failed' | 'error' required

An enumeration.

datestring date-time required
date_bankstring date

Example response

{
  "id": "pout_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.