Skip to content

Payout fees and limits

What a payout costs is on its quote, in four parts. What it may be is your workspace's limits, read from the server.

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.

No payout price or limit is published, and none is stated here. The server states the charge on every quote and payout, and your limits on one read.

Fees

A quote's charge says what your USD balance is charged, in integer micro-dollars written as strings, apart from what the recipient receives. POST /payouts/quotes is the one place to read it: never work a fee out yourself.

FieldDescription
Currencycharge.currency · string · requiredUSD.
Payout value microscharge.payout_value_micros · string · requiredWhat the recipient amount is worth at the quote's rate.
Platform fee microscharge.platform_fee_micros · string · requiredNasfam's fee for sending it.
Network fee microscharge.network_fee_micros · string · requiredThe network's fee, Nasfam's own estimate for the network. A request never supplies one.
Conversion fee microscharge.conversion_fee_micros · string · requiredThe spread on the rate.
Total microscharge.total_micros · string · requiredWhat your USD balance is charged in all: the sum of the four.

The total is the payout value, the platform fee, the network fee and the conversion fee added up, a whole number of cents. The network fee is Nasfam's own estimate for the network; a request never supplies one.

Limits

GET /payout-limits answers your workspace's payout limits as they govern it now, and what your open and completed payouts have used of them. It needs payouts:read and moves nothing. Nasfam staff set the figures, two people deciding every change, so read them here rather than keeping a copy.

FieldDescription
Objectobject · string · requiredpayout_limits.
Setset · boolean · requiredWhether limits are set here. false: none is, so every payout is refused, and every figure is null.
Scopescope · string or null · requiredworkspace (figures set for your workspace alone) or standard (the figures every workspace has).
Per transferper_transfer · object or null · requiredThe most one payout may be worth.
Limit microsper_transfer.limit_micros · string · requiredIn micro-dollars.
Dailydaily · object or null · requiredThe most your payouts may be worth in any rolling 24 hours, and what they used.
Windowdaily.window · string · requiredrolling_24h.
Limit microsdaily.limit_micros · string · requiredIn micro-dollars.
Used microsdaily.used_micros · string · requiredWhat your open and completed payouts used, in micro-dollars.
Hourlyhourly · object or null · requiredHow many payouts you may open in any rolling hour, and how many you did.
Windowhourly.window · string · requiredrolling_1h.
Limithourly.limit · integer · requiredPayouts you may open in any rolling hour.
Usedhourly.used · integer · requiredPayouts opened in the last hour.
Updated atupdated_at · string or null · requiredWhen the figures in force were decided.
  • per_transfer is the most one payout's total charge may be, daily the total of your payouts in any rolling 24 hours, and hourly how many you may open in any rolling hour.
  • scope is workspace when your workspace has figures of its own, and standard otherwise. With set false no limits are set here, so every payout is refused. A limit of zero refuses every payout too.
  • A platform limit shared by every workspace can also refuse a payout, and is not shown.
  • A payout over a limit is refused with payout_limit_reached, and nothing is held. Its detail names the window, never a figure.
  • Above what one payout may be priced at, a request is refused with amount_above_maximum.
  • Above your available USD balance, it is refused with insufficient_funds, and nothing is held.
Code for Limits
curl "https://sandbox-api.nasfampay.com/v1/payout-limits" \  -H "Authorization: Bearer $NASFAM_SANDBOX_KEY"

Request limits

POST /payouts/quotes, POST /payouts, POST /payouts/address-validations share one bucket of 10 requests per 10 seconds for your whole workspace. The reads draw on the reads bucket. Past either, a request is refused with rate_limited and a Retry-After. See Rate limits for the headers.