Skip to content

List events

GET/events

Event log (30-day retention).

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.

Parameters

FieldDescription
Limitlimit · query integer1 to 100. Default 20.
Cursorcursor · query stringUp to 256 characters.
Typetype · query stringOne of order.accepted, order.processing, order.succeeded, order.failed, order.refunded, order.under_review, funding.credited, deposit.confirmed, balance.low, balance.recovered.
The request in cURL, JavaScript and Python
GET /v1/eventsSandbox, test key
const response = await fetch('https://sandbox-api.nasfampay.com/v1/events', {  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/eventsSandbox, test key
// npm install axiosimport axios from 'axios';try {  const { status, data: events } = await axios.get(    'https://sandbox-api.nasfampay.com/v1/events',    {      params: { type: 'order.succeeded' },      headers: {        Authorization: `Bearer ${process.env.NASFAM_SANDBOX_KEY}`,      },    },  );  console.log(status, events);} 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
OK200Events, newest first. 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. ).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

Fields of the 200 body

FieldDescription
Has morehas_more · boolean · required
Next cursornext_cursor · string or null · required
Datadata · array of Event · required
IDdata[].id · string · requiredPattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$.
Typedata[].type · string · requiredOne of order.accepted, order.processing, order.succeeded, order.failed, order.refunded, order.under_review, funding.credited, deposit.confirmed, balance.low, balance.recovered.
Timestampdata[].timestamp · string · requiredFormat date-time.
Environmentdata[].environment · string · requiredOne of live, sandbox.
API versiondata[].api_version · string · requiredAlways v1.
Datadata[].data · object · required
Objectdata[].data.object · object · requiredA full snapshot of the subject: the order for an order.* event, as GET /orders/{id} presents it; the funding for funding.credited, as GET /fundings presents it; the deposit for deposit.confirmed, as GET /funding/deposits presents it, so its status reads confirming until it is booked; for balance.low and balance.recovered only alert_id, state (firing or recovered) and at, never an amount, a threshold or a balance: read GET /v1/balance for the figures. A balance event is sent only to an organisation that chose the webhook channel for its low-balance alert.
Testdata[].test · stringPresent only on a test event (sendWebhookTestEvent), whose object is synthetic: never act on it as a real order or funding. Always true.

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
{  "data": [    {      "id": "evt_01K7SAMP000000000000000001",      "type": "order.accepted",      "timestamp": "2026-10-10T10:05:02Z",      "environment": "sandbox",      "api_version": "v1",      "data": {        "object": {}      },      "test": true    }  ],  "has_more": false,  "next_cursor": null}
Code for Responses
Response
JSON
200 OKSynthetic sandbox data
{  "data": [    {      "id": "evt_01K7SAMP000000000000000090",      "type": "order.succeeded",      "timestamp": "2026-10-10T10:15:05.000Z",      "environment": "sandbox",      "api_version": "v1",      "data": {        "object": {          "id": "ord_01K7SAMP000000000000000090",          "environment": "sandbox",          "status": "succeeded",          "status_reason": null,          "product": "telegram_stars",          "selection": {            "quantity": 50          },          "recipient": {            "telegram_username": "nasfam_test_ok"          },          "amount": {            "amount": 75,            "currency": "USD"          },          "quote_id": null,          "pricing_version": "sandbox-synthetic-v1",          "reference": "TEST-0001",          "version": 2,          "estimated_completion_at": "2026-10-10T10:15:05.000Z",          "created_at": "2026-10-10T10:15:02.000Z",          "updated_at": "2026-10-10T10:15:05.000Z",          "completed_at": "2026-10-10T10:15:05.000Z"        }      }    }  ],  "has_more": false,  "next_cursor": null}
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 sandboxLists your sandbox events, kept for 30 days.
On LiveThe 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.