Authentication for payouts
Payouts take the same secret key as every other request, from your server only, with one of two scopes.
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.
A payout is authorised the way an order is: your secret API key, sent from your server. See Authentication for the header and the key types.
Scopes
| Scope | Requests | What it allows |
|---|---|---|
payouts:read | GET /payout-networks, POST /, GET /payouts/{id}, GET /payouts, GET /payout-limits | Reads payouts and limits, checks addresses and lists networks. Moves nothing. |
payouts:write | POST /payouts/quotes, POST /payouts | Quotes and sends payouts. Cannot read them: pair it with payouts:read. |
- A key with only
payouts:readcan move nothing: give it to a dashboard or a reconciliation job. - A key with only
payouts:writecannot read a payout back. Give the service that sends both scopes. - A request without its scope is refused with
insufficient_scope. - A key holds
payouts:readonly if the member who made it can read payouts.
Who decides where money goes
No payout operation adds an address to pay. A payout pays only an approved destination of your workspace, one that two people of your workspace approved in the dashboard, so a leaked key cannot send your balance to a new address.
Keep the key on your server
Never call these operations from a browser or a mobile app. A key that can move money must never reach a device you do not control.
Related guides
- Authentication: the header and the key types.
- API keys: making and revoking a key.
- Screening and approved destinations: what decides who can be paid.
