Skip to main content
API keys used to create cash payouts must have IP whitelisting configured — see Getting API Credentials.
1

Get available currencies for payout

GET /ledger/cash-payments/currencies — see Beneficiaries for the full currency/channel table.
2

Get a quote

POST /ledger/cash-payments/quotes locks in a conversion rate for the payout amount and currency.
3

Create the payout

POST /ledger/cash-payments using the quote reference and a saved beneficiary ID.
4

Query status or listen for webhooks

Poll GET /ledger/cash-payments/{reference}, or subscribe to transaction_activity.cash_payment.* — see Webhooks for Cash Payouts.
5

List payouts

GET /ledger/cash-payments returns all payouts.