How it works
Check the fee
Call
GET /payout/fee/{chain}/{coin}/{amount} to see the fee and net amount before
committing.Submit the payout
Call
POST /payout/crypto with the coin, chain, amount, and either a wallet address or
a saved payoutAccountId.Prerequisites
Authentication guide
All requests require an HMAC-SHA256 signature. See the authentication guide for code examples.
Step 1 — Check the fee
Step 2 — Submit a payout to a wallet address
Step 2 (alt) — Payout to a saved payout account
Step 3 — Poll for completion
Payout status values
| Status | Meaning |
|---|---|
pending | Queued, not yet sent on-chain |
processing | Broadcast to the network |
completed | Confirmed on-chain |
failed | Rejected — see failureReason |
Error handling
| Scenario | Action |
|---|---|
| Insufficient balance | Check merchant balance before submitting |
| Amount below minimum | Call the fee endpoint first; verify amountAfterFee > 0 |
status: "failed" | Read failureReason on the payout record |
Neither address nor payoutAccountId provided | Exactly one must be supplied; omitting both returns 400 |