Sign in
Payouts

Create Payout

Creates a payout from a stablecoin account to a saved payout method. The account's funds move from its stablecoin balance to an external bank account, wallet, or crypto address. Accounts that pay out from a fiat balance use POST /withdrawals. Requires the payouts API to be enabled for the account; contact support to enable it. The payout settles asynchronously; poll GET /payouts for the entry whose payout_request_id matches this payout's id.

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 required

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

amountnumber float required

The amount to pay out in the specified currency.

currencystring

The payout currency. Defaults to usd.

payout_method_idstring required

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

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

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

Changes