Create Payout
Sends money from an account’s or user’s balance to one of its saved payout methods.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-08-05-1"
Body
The amount to pay out in the specified currency.
The saved payout method to deliver to (a potk_ identifier).
The account to pay out from (a biz_ identifier). Provide this or user_id.
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.
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.
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.
How fast the funds should arrive. instant is only accepted when the account and payout method are eligible; otherwise the payout is rejected.
standard, instant The user to pay out from (a user_ identifier). Provide this or account_id.
Response
payout created
The payout amount in whole currency units.
When the payout was created.
Payout currency.
Estimated time the funds become available in the destination account. Null until the payout settles.
The fee charged for the payout, in the payout currency.
Payout ID.
payout Name of the entity processing the payout. Null until the payout settles.
The saved payout method used. Requires payout:destination:read; null without it.
Payout delivery speed.
standard, instant Current payout status, in the same vocabulary as GET /payouts.
requested, awaiting_payment, in_transit, completed, failed, canceled, denied 
