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-07-31"

Body

application/json
account_id
string
required

The account to pay out from (a biz_ identifier).

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).

currency
string

The payout currency. Defaults to usd.

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,
in_transit,
denied,
completed,
failed,
canceled