Skip to content

Test payouts in the sandbox

How payouts are tested on synthetic money before any real money moves.

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.

The sandbox runs the same operations, checks and statuses as Live will, on synthetic money. A sandbox payout is simulated: nothing reaches a real network, and its chain.tx_hash is a simulated one with no chain.explorer_url.

When the sandbox serves payouts

  • Payouts are served once Nasfam switches them on in the sandbox. Until then every request answers 503 payouts_unavailable, and GET /payout-networks answers the same.
  • Once they are on, the pairs you may test are those listed with status sandbox.
  • Use a sandbox key (nbk_test_) and the sandbox host. A sandbox key pays only synthetic money.

What to prove before Live

  • You mark a payout paid only when it reads delivered: true.
  • A timeout leaves your record as unknown, and you retry with the same key or read the payout instead of sending a new one.
  • A replay answers the payout as it was first made: you read its later state with a read, never from a replay.
  • Receiving or reading the same version twice changes nothing on your side.
  • A payout in held or reconciliation_required is waited for, never paid again.
  • A new attempt after a failure is a new payout, with a new key and a new quote.
  • A quote past its expires_at, an address with each of the problems a validation finds, and price_changed above your max_total_charge are each handled.