List statements
GET/statements
The workspace's statements, newest first.
Sandbox: test money only. No request moves real money.
Authenticate with your sandbox key as a bearer token: Authorization: Bearer nbk_test_..
Needs statements:read.
Request
| Header | Value | Sent |
|---|---|---|
Authorization | Bearer nbk_test_... | Required |
No Idempotency-Key is needed: a read changes nothing, so it is safe to send again.
Parameters
| Field | Description |
|---|---|
| Limitlimit · query integer | 1 to 100. Default 20. |
| Cursorcursor · query string | Up to 256 characters. |
const response = await fetch( 'https:// sandbox-api. nasfampay. com/ v1/ statements', { 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);// npm install axiosimport axios from 'axios';try { const { status, data: statements } = await axios. get( 'https:// sandbox-api. nasfampay. com/ v1/ statements', { params: { limit: 10 }, headers: { Authorization: `Bearer ${process. env. NASFAM_ SANDBOX_ KEY}`, }, }, ); console. log( status, statements);} 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
| Status | Meaning | Body |
|---|---|---|
| OK200 | Statements. 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.
). | StatementList object |
| Too many requests429 | Too 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 statusdefault | Error (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 statement list object
| Field | Description |
|---|---|
| Datadata · array of Statement · required | |
| IDdata[]. | Pattern ^stm_[0-9A-HJKMNP-TV-Z]{26}$. |
| Statedata[]. | One of queued, ready, failed. |
| Failure codedata[]. | One of reconciliation_failed, too_large, null. |
| Currencydata[]. | One of USD. |
| Timezonedata[]. | |
| Reconcileddata[]. | |
| Perioddata[]. | |
| Fromdata[]. | Format date. |
| Todata[]. | Format date. |
| From atdata[]. | Format date-time. |
| To atdata[]. | Format date-time. |
| Formatsdata[]. | Each one of csv, pdf. |
| Movement countdata[]. | At least 0. |
| Created atdata[]. | Format date-time. |
| Finished atdata[]. | Format date-time. |
| Filesdata[]. | |
| Formatdata[]. | One of csv, pdf. |
| Byte sizedata[]. | At least 1. |
| Sha256data[]. | Pattern ^[0-9a-f]{64}$. |
| Expires atdata[]. | Format date-time. |
| Availabledata[]. | |
| Summarydata[]. | Either shape 1: ; or shape 2: opening, closing, categories, spent, orders_charged, deposits_credited, reservations_returned, refunded, adjustments, spent_by_product. |
| Has morehas_ | |
| Next cursornext_ |
Responses are extensible: ignore fields, enum values and event types you do not know. Any other status is a Problem (see Errors).
{ "data": [ { "id": "stm_ 01K7SAMP000000000000000001", "state": "queued", "failure_ code": null, "currency": "USD", "timezone": "string", "reconciled": true, "period": { "from": "2026-10-10", "to": "2026-10-10", "from_ at": "2026-10-10T10:05:02Z", "to_ at": "2026-10-10T10:05:02Z" }, "formats": [ "csv" ], "movement_ count": null, "created_ at": "2026-10-10T10:05:02Z", "finished_ at": null, "files": [ { "format": "csv", "byte_ size": 1, "sha256": "0000000000000000000000000000000000000000000000000000000000000000", "expires_ at": "2026-10-10T10:05:02Z", "available": true } ], "summary": null } ], "has_ more": false, "next_ cursor": null}{ "data": [ { "id": "stm_ 01K7SAMP000000000000000090", "state": "ready", "failure_ code": null, "currency": "USD", "timezone": "Africa/ Lagos", "reconciled": true, "period": { "from": "2026-10-01", "to": "2026-10-10", "from_ at": "2026-09-30T23:00:00.000Z", "to_ at": "2026-10-09T23:00:00.000Z" }, "formats": [ "csv" ], "movement_ count": 2, "created_ at": "2026-10-10T10:20:00.000Z", "finished_ at": "2026-10-10T10:20:04.000Z", "files": [ { "format": "csv", "byte_ size": 1240, "sha256": "0000000000000000000000000000000000000000000000000000000000000000", "expires_ at": "2026-10-10T11:20:04.000Z", "available": true } ], "summary": { "opening": { "available": "0", "reserved": "0", "on_ hold": "0", "total": "0" }, "closing": { "available": "99250000", "reserved": "0", "on_ hold": "0", "total": "99250000" }, "categories": [ { "category": "deposit", "label": "Deposits credited", "count": 1, "change": { "available": "100000000", "reserved": "0", "on_ hold": "0", "total": "100000000" } }, { "category": "order", "label": "Orders charged", "count": 1, "change": { "available": "-750000", "reserved": "0", "on_ hold": "0", "total": "-750000" } } ], "spent": "750000", "orders_ charged": 1, "deposits_ credited": "100000000", "reservations_ returned": "0", "refunded": "0", "adjustments": "0", "spent_ by_ product": [ { "product": "telegram_ stars", "spent": "750000", "count": 1 } ] } } ], "has_ more": false, "next_ cursor": null}{ "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 | |
|---|---|
| Authentication | Your key as a bearer token in the Authorization header: a nbk_test_ key on the sandbox host. |
| Idempotency | Not needed: a GET changes nothing, so it is safe to send again. |
| In the sandbox | Served, on your own test records. |
| On Live | The same request, on the Live host with a live key, which exists only for a workspace activated for Live. See Go live. |
| Funding | None. This request does not touch your balance. |
| Status changes | None. |
| Webhook events | None. |
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.
