Skip to content

Get account

GET/account

GET /account

Sandbox: test money only. No request moves real money.

Authenticate with your sandbox key as a bearer token: Authorization: Bearer nbk_test_....

Request

HeaderValueSent
AuthorizationBearer nbk_test_...Required

No Idempotency-Key is needed: a read changes nothing, so it is safe to send again.

The request in cURL, JavaScript and Python
GET /v1/accountSandbox, test key
const response = await fetch('https://sandbox-api.nasfampay.com/v1/account', {  headers: {    Authorization: `Bearer ${process.env.NASFAM_SANDBOX_KEY}`,  },});if (!response.ok) {  const problem = await response.json();  throw new Error(`${problem.status} ${problem.code}: ${problem.title} (request ${problem.request_id})`);}const result = await response.json();console.log(response.status, result);
Code for Request
GET /v1/accountSandbox, test key
// npm install axiosimport axios from 'axios';try {  const { status, data: account } = await axios.get(    'https://sandbox-api.nasfampay.com/v1/account',    {      headers: {        Authorization: `Bearer ${process.env.NASFAM_SANDBOX_KEY}`,      },    },  );  console.log(status, account);} catch (error) {  if (!axios.isAxiosError(error) || !error.response) throw error;  const problem = error.response.data;  throw new Error(`${problem.status} ${problem.code}: ${problem.title} (request ${problem.request_id})`);}

Responses

StatusMeaningBody
OK200The organisation behind this key. Headers: RateLimit (draft-ietf-httpapi-ratelimit-headers-11. the same buckets, each "<bucket>";r=<whole requests remaining, never negative>;t=<seconds until the quota is fully available again>. ), RateLimit-Policy (draft-ietf-httpapi-ratelimit-headers-11. a structured field list with one item per bucket the request drew on (orders, quotes, quotes_daily, reads, webhooks, lookups, lookups_org, lookups_daily), each "<bucket>";q=<quota>;w=<window seconds>. no partition key (pk) is sent. ).Account object
Too many requests429Too many requests (rate_limited), or your queued orders are at your cap (queue_limit). A bucket that cannot be read at once because of contention is answered here too, never waited on. Honour Retry-After. . Headers: Request-Id, Retry-After (seconds to wait before retrying), RateLimit (draft-ietf-httpapi-ratelimit-headers-11. the same buckets, each "<bucket>";r=<whole requests remaining, never negative>;t=<seconds until the quota is fully available again>. ), RateLimit-Policy (draft-ietf-httpapi-ratelimit-headers-11. a structured field list with one item per bucket the request drew on (orders, quotes, quotes_daily, reads, webhooks, lookups, lookups_org, lookups_daily), each "<bucket>";q=<quota>;w=<window seconds>. no partition key (pk) is sent. ).Problem object
Any other statusdefaultError (RFC 9457). A 503 service_unavailable with Retry-After means the request was not processed: the rate limiter or the database could not answer, and the API refuses rather than serve unlimited (reads included). For a money-moving operation, retrying with the same Idempotency-Key is always safe. . Headers: Request-Id, Retry-After (on 429 and some 503 responses).Problem object

The account object

FieldDescription
IDid · string · requiredPattern ^org_[0-9A-HJKMNP-TV-Z]{26}$.
Namename · string · required
Environmentenvironment · string · requiredOne of live, sandbox.
KYB statuskyb_status · string · requiredIn the sandbox, sandbox_only for an organisation in good standing: no KYB is recorded there. In Live, the activation state, active once the organisation is activated. restricted, suspended and closed in either. One of sandbox_only, draft, submitted, in_review, needs_info, verified, rejected, active, restricted, suspended, closed.
Limitslimits · object · requiredThe limits the server keeps for this organisation. Rate limits are not here; each response's RateLimit-Policy header states the buckets it drew on.
Max queuedlimits.max_queued · integer · requiredThe most orders that may be processing at once; an order beyond it is 429 queue_limit. 1 to 1000.

Responses are extensible: ignore fields, enum values and event types you do not know. Any other status is a Problem (see Errors).

Every kind of response
200 OKSynthetic sandbox data
{  "id": "org_01K7SAMP000000000000000001",  "name": "Example Business Ltd",  "environment": "sandbox",  "kyb_status": "sandbox_only",  "limits": {    "max_queued": 50  }}
Code for Responses
Response
JSON
200 OKSynthetic sandbox data
{  "id": "org_01K7SAMP000000000000000090",  "name": "Example Business Ltd",  "environment": "sandbox",  "kyb_status": "sandbox_only",  "limits": {    "max_queued": 50  }}
Error
JSON
429 Too Many RequestsSynthetic sandbox data
{  "type": "about:blank",  "title": "Too many requests",  "status": 429,  "code": "rate_limited",  "category": "rate_limit",  "detail": "Too many requests. Retry after the time in Retry-After.",  "param": null,  "request_id": "req_01K7SAMP000000000000000090"}

How it behaves

What to expect
AuthenticationYour key as a bearer token in the Authorization header: a nbk_test_ key on the sandbox host.
IdempotencyNot needed: a GET changes nothing, so it is safe to send again.
In the sandboxenvironment is sandbox, and kyb_status is sandbox_only for an organisation in good standing.
On Livekyb_status is active once the organisation is activated. The same request, on the Live host with a live key, which exists only for a workspace activated for Live. See Go live.
FundingNone. This request does not touch your balance.
Status changesNone.
Webhook eventsNone.

Error responses

Any request can answer with invalid_request, invalid_api_key, key_expired, key_environment_mismatch, insufficient_scope, rate_limited, service_unavailable, internal_error. Errors says what to do about each one.