Sign in

v14

latestOpenAPI 3.1.02026-08-083813925.4 MB
Payouts

Create Payout

Sends money from an account's or user's balance to one of its saved payout methods.

post/payouts

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

The account to pay out from (a biz_ identifier). Provide this or user_id.

amountnumber float required

The amount to pay out in the specified currency.

currencystring

The currency to pay out. Balances are held per currency and the payout draws only from the balance in this currency, so match the currency the funds arrived in — for example cad for an account funded by CAD transfers. Defaults to usd.

idempotency_keystring nullable

A unique key that makes retries safe. Retrying with the same key returns the original payout instead of paying out twice. Also accepted as the Idempotency-Key header.

payout_method_idstring required

The saved payout method to deliver to (a potk_ identifier).

platform_covers_feesboolean

Whether the parent platform covers the payout fee instead of the account being paid out. Omit to use the platform's configured fee coverage policy; pass false to opt out of it. true is only accepted for accounts that belong to a platform, and requires the platform's policy to cover this payout method's category or a caller authorized to manage the platform's child account fees.

speed'standard' | 'instant'

How fast the funds should arrive. instant is only accepted when the account and payout method are eligible; otherwise the payout is rejected.

user_idstring

The user to pay out from (a user_ identifier). Provide this or account_id.

Response

payout created

amountnumber float required

The payout amount in whole currency units.

created_atstring date-time required

When the payout was created.

currencystring required

Payout currency.

estimated_arrivalstring date-time nullable required

Estimated time the funds become available in the destination account. Null until the payout settles.

fee_amountnumber float required

The fee charged for the payout, in the payout currency.

idstring required

Payout ID.

object'payout' required
payer_namestring nullable required

Name of the entity processing the payout. Null until the payout settles.

speed'standard' | 'instant' required

Payout delivery speed.

status'requested' | 'awaiting_payment' | 'in_transit' | 'completed' | 'failed' | 'canceled' | 'denied' required

Current payout status, in the same vocabulary as GET /payouts.