POST /payout/simple to send a payment to one beneficiary. It requires a saved beneficiary with an attached payment method. See Beneficiaries for setting up beneficiaries.
All payout requests require an
Idempotency-Key header. Your wallet balance is charged when the payout is submitted.Single Payout
Send one payment to a saved beneficiary payment method.string
required
The wallet currency to debit, for example
"USD".number
required
Amount to send in the debit wallet currency.
number
required
The beneficiary
id (from Add Beneficiary).string
required
The customer the payout is for. If the beneficiary belongs to a customer, it must be that customer.
string
Optional. The beneficiary that owns the payment method.
string
Payment reference shown to the recipient’s bank, up to 250 characters. Some payout rails shorten it or remove unsupported characters.
/payout/simple also accepts quote_id, invoice and invoice_url, like POST /wallet/payout.
List Payouts
Retrieve a paginated list of all your payouts.Get Single Payout
string
required
The UUID of the payout to retrieve.
Payout vs. Wallet Payout
For a single payment where you want to lock a rate first, use
POST /exchange-rate (with method_type: "payout") → POST /wallet/payout. To fix what the customer receives rather than what you send, see Pay out by receive amount.
