Sign in
OpenAPI 3.1.02026-08-133854115.5 MB

48408451a1f0

Payouts

Create Payout

Sends money from an account or user balance to a saved payout method for that owner.

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

OR

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.

notesstring nullable required

Free-form notes attached by the payout creator, or null when none were provided. Maximum 255 characters.

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

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

trace_codestring nullable required

ACH trace number the recipient's bank can use to locate this payout. Always null here — it is assigned when the payout is submitted to the bank, and appears on the payout in GET /payouts once it has been sent; payouts not sent over ACH never get one.