Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

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

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-05-1"

Body

application/json
amount
number<float>
required

The amount to pay out in the specified currency.

payout_method_id
string
required

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

account_id
string

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

currency
string

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_key
string | null

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.

platform_covers_fees
boolean

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
enum<string>
default:standard

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

Available options:
standard,
instant
user_id
string

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

Response

payout created

amount
number<float>
required

The payout amount in whole currency units.

created_at
string<date-time>
required

When the payout was created.

currency
string
required

Payout currency.

estimated_arrival
string<date-time> | null
required

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

fee_amount
number<float>
required

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

id
string
required

Payout ID.

object
enum<string>
required
Available options:
payout
payer_name
string | null
required

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

payout_method
object | null
required

The saved payout method used. Requires payout:destination:read; null without it.

speed
enum<string>
required

Payout delivery speed.

Available options:
standard,
instant
status
enum<string>
required

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

Available options:
requested,
awaiting_payment,
in_transit,
completed,
failed,
canceled,
denied