Screening and approved destinations
Who a payout may be sent to: your approved destinations, each screened before it is paid.
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.
Two things decide who can be paid: your workspace's approved destinations, and the screening of each one. There is no screening operation to call. You read the answer on the payout, as screening.status, and an address validation never screens.
Approved destinations
A payout pays only an address that two people of your workspace approved as a destination, for that asset and network, in the dashboard. Anything else is refused with destination_not_approved, before any money is held. POST / tells you which destination an address is, as its destination_id.
Screening
Every payout carries the destination's newest screening answer for exactly its address and memo, in screening.status. A payout is sent only under approved_under_policy:
| Screening | What it means for the payout |
|---|---|
| Not screenednot_ | Not asked yet. The payout waits, and is never sent unscreened. |
| Approved under policyapproved_ | May be paid. The only answer that lets a payout be sent. |
| Review requiredreview_ | Held, never sent, until Nasfam reviews it. |
| Restrictedrestricted | Held, never sent, until Nasfam reviews it. |
| Screening unavailablescreening_ | No answer yet. The payout waits and is screened again, never sent unscreened. |
| Unsupportedunsupported | No answer for this address yet. The payout waits and is screened again, never sent unscreened. |
A payout held for review is in held, its charge held, and moves on only when the review ends. It is never sent unscreened, and its charge is never returned on a timer.
When a payout stops for a check
A payout can end without being sent, its charge returned once, for a reason its failure_reason names:
screening_restricted: the destination's screening restricts it.destination_unusable: the destination could no longer be paid.policy_blocked: your workspace's transaction policy blocked it.
Do not send the same payout again on your own. A new attempt is a new payout, with a new key and a new quote.
Related guides
- Validate an address: the form, and the destination it is.
- Authentication for payouts: what a key can and cannot do.
- Track a payout: every
failure_reason.
