v8

OpenAPI 3.1.02026-08-033623795.0 MB

Payouts

Create Payout

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

post/payouts

Idempotency-Keystring

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

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

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

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.

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