Skip to content

Get started with Crypto Payouts

The first payout from a server: read the pairs, check the address, quote, send and follow it.

Sandbox: test money only. No request moves real money.

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.

Every call is made from your server with your secret key. Nothing here is called from a browser. The samples use a sandbox key and placeholders: ASSET and network_id stand for a pair the server lists, and the address for one of your approved destinations.

Your first payout

  1. Call GET /payout-networks and offer only the pairs whose status is sandbox on the sandbox host.
  2. Have the address approved as a destination of your workspace, by two people, for that asset and network. A payout pays nothing else.
  3. Check it with POST /payouts/address-validations, with a memo where the pair's memo_rule asks for one, and show any problems.
  4. Quote it with POST /payouts/quotes and a new Idempotency-Key, naming in amount what the recipient receives.
  5. Show the quote's charge and its expires_at.
  6. Make another Idempotency-Key, store it with your own record of the payout, and call POST /payouts with the quote's id as quote_id and the same asset, network, amount, address and memo, before the quote expires.
  7. Read the payout until it ends, and mark it paid only when it reads delivered: true.
Code for Your first payout
curl "https://sandbox-api.nasfampay.com/v1/payout-networks" \  -H "Authorization: Bearer $NASFAM_SANDBOX_KEY"

Before you start

  • An API key with payouts:read and payouts:write: the first reads, the second quotes and sends.
  • An approved destination for each address you will pay.
  • Money in your sandbox USD balance to cover the total charge.
  • A record on your side for each payout, holding its key, its client_reference and its id.