Skip to content

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

  1. Read the pairs with GET /payout-networks, and offer only those whose status is this environment's.
  2. Check the address with POST /payouts/address-validations: its form, and whether it is one of your approved destinations.
  3. Price it with POST /payouts/quotes. The quote holds nothing and locks the price for up to 60 seconds.
  4. Send it with POST /payouts. The answer is 202: the total charge is held, and nothing has left yet.
  5. Follow it by its events on a subscribed endpoint, and read it with GET /payouts/{id}, until it is completed, failed or cancelled.

The operations

RequestWhat it doesScopeEffect
GET /payout-networksThe assets and networks payouts know here, each with its statuspayouts:readReads. Moves nothing.
POST /payouts/address-validationsCheck an address's form for an asset and network, and whether it is an approved destinationpayouts:readReads. Moves nothing.
POST /payouts/quotesPrice a crypto payout and lock the rate for up to 60 secondspayouts:writeHolds nothing.
POST /payoutsSend a crypto payout (the total charge is held before the response)payouts:writeHolds the total charge from your balance.
GET /payouts/{id}Retrieve a payoutpayouts:readReads. Moves nothing.
GET /payoutsList payouts, newest firstpayouts:readReads. Moves nothing.
GET /payout-limitsYour workspace's payout limits and what your payouts have used of thempayouts:readReads. 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_unavailable until Nasfam switches payouts on there.
  • Live: not yet available. Every request on Live answers 503 payouts_unavailable, and no pair is live.

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.