Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.noxpay.io/llms.txt

Use this file to discover all available pages before exploring further.

GET /v2/statement
Authorization: Bearer <your-api-key>
Each entry represents a single debit or credit line against one of your sub-accounts, with a balance before and after. When the movement was generated by a Noxpay process — Crossramp Checkout, onramp, offramp, withdrawal — the full transaction object is embedded inline.

Query parameters

ParameterTypeDescription
limitintegerMax results per page (default: 20, max: 100)
offsetintegerPagination offset (default: 0)
currencystringFilter by currency code (e.g. USDT_TRX, BRL)
account_typestringFilter by sub-account: available, in_transit, to_receive, or blocked
date_fromstringStart date filter — YYYY-MM-DD
date_tostringEnd date filter — YYYY-MM-DD

Response 200 OK

{
  "total": 128,
  "limit": 20,
  "offset": 0,
  "entries": [
    {
      "id": 4521,
      "date": "2024-05-01T12:00:00Z",
      "account": {
        "id": 42,
        "name": "USDT (TRX) available",
        "code": "2.1.1.100.1.1.1",
        "currency": "USDT_TRX",
        "currency_pretty_name": "USDT (TRX)"
      },
      "debit": 0.00,
      "credit": 100.00,
      "previous_balance": 50.00,
      "balance": 150.00,
      "transaction": {
        "end2end": "NOXabc123",
        "template": "crossramp_checkout",
        "created_at": "2024-05-01T11:59:00Z",
        "updated_at": "2024-05-01T12:00:00Z",
        "status": { "en": "Success", "pt": "Sucesso" },
        "substatus": { "en": "Success", "pt": "Sucesso" },
        "message": { "en": "Transaction completed successfully", "pt": "Transação concluída com sucesso" },
        "error_message": { "en": "", "pt": "" },
        "attributes": {
          "quote": 5.45,
          "currency_exit_received": "USDT (TRX)",
          "amount_payment": 550.00,
          "amount_received": 100.00,
          "client_name": "João Silva",
          "client_tax_id": "12345678901"
        }
      }
    }
  ]
}

Response fields

FieldTypeDescription
totalintegerTotal matching entries across all pages
limitintegerPage size used
offsetintegerCurrent offset
entriesarrayList of statement entry objects

Statement entry

FieldTypeDescription
idintegerUnique ledger line identifier
datestringISO 8601 timestamp of the journal entry
account.idintegerInternal ledger account ID
account.namestringHuman-readable label (e.g. USDT (TRX) available)
account.codestringFull double-entry account code (e.g. 2.1.1.100.1.1.1)
account.currencystringRaw ledger currency code (e.g. USDT_TRX)
account.currency_pretty_namestringDisplay name (e.g. USDT (TRX))
debitfloatAmount debited from this account
creditfloatAmount credited to this account
previous_balancefloatAccount balance before this entry
balancefloatAccount balance after this entry
transactionobject | nullEmbedded transaction object when generated by a Noxpay process; null for internal adjustments

Account sub-type from code

The last segment of account.code identifies the sub-account bucket:
Code segmentTypeDescription
1availableImmediately withdrawable
2in_transitSent; awaiting on-chain confirmation
3to_receivePending inbound
4blockedFrozen for compliance or dispute

Embedded transaction object

When transaction is present, the template field tells you what kind of process generated the entry:
Template valueProcess
crossramp_checkoutCrossramp Checkout
onrampOnramp to Account
onramp_instantOnramp to Address
offrampOfframp from Account
offramp_instantOfframp from External Address
withdraw_dash_same_currWithdrawal
The attributes object contains the fields relevant to that template. See the per-resource pages for full attribute tables.