Create payout
POST /transfer/payout
Create a payout from the tenant's vault wallet to an external address. Provide either `amount` (crypto) or `usd_amount` (converted to crypto at the current rate). Payouts are idempotent by `(vault_id, reference_id)` — resubmitting a `reference_id` returns `409` instead of paying twice.
Request body
Create payout request.
- vault_idstringrequired
The vault the funds leave from.
- assetstringrequired
Asset symbol to send.
- network_symbolstringrequired
Network slug.
- to_addressstringrequired
External destination address.
- reference_idstringrequired
Your idempotency key — unique per vault.
- amountstring
Crypto amount; provide either `amount` or `usd_amount`.
- usd_amountstring
USD amount; converted to crypto at the current rate.
- remarkstring
Free-form note stored on the payout.
- expired_atstringformat: date-time
Cutoff after which a non-confirmed payout expires.
Responses
The payout was created.
- idstring
- vault_idstring
- assetstring
- network_symbolstring
- amountstring
Crypto amount sent.
- usd_amountstring
USD value at submit time.
- ratestring
Conversion rate applied when `usd_amount` was used.
- to_addressstring
- reference_idstring
- remarkstring
- statusstringenum: queued · processing · confirmed · failed · expired
- tx_idstring
On-chain transaction hash; empty until broadcast.
- errorstring
Failure reason when `status` is `failed`; empty otherwise.
- created_atstringformat: date-time
- confirmed_atstringformat: date-time
- expired_atstringformat: date-time