Beneficiaries
Beta: Payouts — Beneficiaries, Customers, and Payouts — are in beta and the API may still change. Contact [email protected] to enable them for your account.
A beneficiary is the destination of a payout: a bank account that receives fiat after a customer’s crypto is off-ramped. You register each beneficiary once and reuse it across any number of payouts and customers.
How It Works
- Register a beneficiary with its bank account details (
POST /beneficiaries). - It becomes
registeredonce the payout account is verified (usually within seconds). - Reference its
idas thebeneficiary_idwhen you create a payout.
Supported Rails
The bank account is described by a bank_account.type discriminator:
| Type | Region | Key fields |
|---|---|---|
| SEPA | Europe | iban |
| ACH / Wire | US | routing_number + account_number |
| SWIFT | International | bic + account_number |
| FPS / CHAPS | UK | sort_code + account_number |
Which rails are enabled depends on your account. Reach out if you need a specific one.
Available Endpoints
- Create Beneficiary — Register a payee bank account
- Get Beneficiary — Retrieve a beneficiary
- List Beneficiaries — List all beneficiaries
