Crypto Payouts
Send crypto from your Nasfam Business USD balance to an approved wallet, priced first and followed until it is final.
Sandbox. The payout operations are in the API's contract and built for the sandbox, where a payout is simulated and never a real transfer. Until Nasfam switches payouts on in an environment, every request there answers 503 payouts_unavailable and nothing is written or held. Live: not yet available.
Availability: Sandbox. Built for the sandbox, on synthetic money. Not live.
Crypto Payouts pays an approved wallet from your USD balance, through the same API key and integration as your orders. You name what the recipient receives; what your balance is charged is disclosed apart, on a quote, before any money moves. Each payout is followed on its network until it is final.
How a payout works
- Read the pairs with
GET /payout-networks, and offer only those whosestatusis this environment's. - Check the address with
POST /: its form, and whether it is one of your approved destinations.payouts/ address-validations - Price it with
POST /payouts/quotes. The quote holds nothing and locks the price for up to 60 seconds. - Send it with
POST /payouts. The answer is202: the total charge is held, and nothing has left yet. - Follow it by its events on a subscribed endpoint, and read it with
GET /payouts/{id}, until it iscompleted,failedorcancelled.
The operations
| Request | What it does | Scope | Effect |
|---|---|---|---|
GET /payout-networks | The assets and networks payouts know here, each with its status | payouts:read | Reads. Moves nothing. |
POST / | Check an address's form for an asset and network, and whether it is an approved destination | payouts:read | Reads. Moves nothing. |
POST /payouts/quotes | Price a crypto payout and lock the rate for up to 60 seconds | payouts:write | Holds nothing. |
POST /payouts | Send a crypto payout (the total charge is held before the response) | payouts:write | Holds the total charge from your balance. |
GET /payouts/{id} | Retrieve a payout | payouts:read | Reads. Moves nothing. |
GET /payouts | List payouts, newest first | payouts:read | Reads. Moves nothing. |
GET /payout-limits | Your workspace's payout limits and what your payouts have used of them | payouts:read | Reads. Moves nothing. |
Where it is served
- Sandbox: the operations are built and simulated, on synthetic money, and nothing reaches a real network. They answer
503 payouts_unavailableuntil Nasfam switches payouts on there. - Live: not yet available. Every request on Live answers
503 payouts_unavailable, and no pair islive.
Where a payout is
A payout moves through its statuses until it is completed, failed or cancelled. Only completed is delivered. Track a payout explains each one and where the charge is in it.
Related guides
- Get started: the first payout, step by step.
- Supported pairs: what a payout can be sent on, and where.
- Track a payout: how to read where a payout is.
