Get Statements

Retrieve transaction ledger entries for the selected account. Use this operation to inspect credit and debit activity, transaction identifiers, payment methods, and pagination metadata.

POST /v3/statements

This is a read operation that uses a signed POST request. Supply a date range in the JSON body. For the current balance and account configuration, use Get Bank Account.

Authentication & headers

Use an ACCOUNT credential for its bound account, or a USER credential authorized to access the selected account. Platform credentials are not accepted.

Select the target account

Credential	Target headers	Rules
`ACCOUNT`	Optional pair: `X-ISPB` and `X-Account-Number`	Omit both to use the bound account. If supplied, both must be present and match that account.
`USER`	Both `X-ISPB` and `X-Account-Number` are required.	Select an account the credential is permitted to access.

Include the exact trimmed values of any account-target headers in the canonical header set before calculating X-Signature. Adding or changing them after signing invalidates the signature.

Send the request headers

Header	Required	Value
`Content-Type`	Yes	`application/json`
`X-Client-ID`	Yes	The client identifier for your credential.
`X-Timestamp`	Yes	Current Unix timestamp in milliseconds.
`X-Nonce`	Yes	A fresh, unique nonce for this request.
`X-Signature`	Yes	HMAC-SHA256 signature generated using the documented canonical request rules.
`X-Content-Hash`	No	Hash of the exact request body. Optional for inbound API calls; if supplied, it must match the bytes sent.

Follow Request signing for the canonical path, query, headers, and body rules. Use the matching base URL and credentials described in Environments.

Request body

Date range and page size

Field	Required	JSON type	Rules
`start_date`	Yes	number	Non-zero Unix timestamp in milliseconds. Must be earlier than `end_date`.
`end_date`	Yes	number	Non-zero Unix timestamp in milliseconds. Must be later than `start_date`.
`page_size`	No	number	From `1` through `100` when supplied.

Send dates as JSON numbers in milliseconds, not seconds or date strings. An empty body object is not a valid example for this operation because both date fields are required.

Optional filters

Field	JSON type	Purpose
`txn_id`	string	Filter by transaction identifier.
`settlement_id`	string	Filter by settlement identifier.
`funds_type`	number	`1` for CREDIT (inbound flow), `2` for DEBIT (outbound flow).
`transaction_type`	number	Transaction-type filter. If omitted, the value becomes `0` and is forwarded to the downstream service.

See Objects & Enums for transaction-type definitions. Do not assume that an omitted transaction_type disables downstream filtering.

Pagination inputs

Field	JSON type	Purpose
`snapshot_timestamp`	number	Optional snapshot timestamp. The response includes a snapshot timestamp for the result set.
`cursor`	object	Optional continuation cursor containing numeric `timestamp`, string `id`, and numeric `direction`. Pass back the complete returned object unchanged.

See Continue through results for an example using the response cursor.

Request

The example requests debit entries with a page size of 20. Its date range runs from December 31, 2025, 00:00 UTC to January 1, 2026, 00:00 UTC. Replace the dates with the period you need.

{
  "start_date": 1767139200000,
  "end_date": 1767225600000,
  "page_size": 20,
  "funds_type": 2
}

Set BASE_URL and your credential variables, then generate TIMESTAMP_MS, NONCE, CONTENT_HASH, and SIGNATURE for the exact request. The commands below include the optional content hash; they do not generate the signature for you.

ACCOUNT credential
USER credential

Uses the account bound to the credential and omits both account-target headers.

curl --request POST "${BASE_URL}/v3/statements" \
  --header "Content-Type: application/json" \
  --header "X-Client-ID: ${CLIENT_ID}" \
  --header "X-Timestamp: ${TIMESTAMP_MS}" \
  --header "X-Nonce: ${NONCE}" \
  --header "X-Content-Hash: ${CONTENT_HASH}" \
  --header "X-Signature: ${SIGNATURE}" \
  --data '{"start_date":1767139200000,"end_date":1767225600000,"page_size":20,"funds_type":2}'

Set ISPB and ACCOUNT_NUMBER to a permitted account. Include both headers in the canonical header set before signing.

curl --request POST "${BASE_URL}/v3/statements" \
  --header "Content-Type: application/json" \
  --header "X-Client-ID: ${CLIENT_ID}" \
  --header "X-Timestamp: ${TIMESTAMP_MS}" \
  --header "X-Nonce: ${NONCE}" \
  --header "X-Content-Hash: ${CONTENT_HASH}" \
  --header "X-ISPB: ${ISPB}" \
  --header "X-Account-Number: ${ACCOUNT_NUMBER}" \
  --header "X-Signature: ${SIGNATURE}" \
  --data '{"start_date":1767139200000,"end_date":1767225600000,"page_size":20,"funds_type":2}'

If you change dates, filters, or cursor values, recalculate the body hash and signature for the new request. Keep the body bytes unchanged after signing and use a fresh nonce.

Success response

A successful API result has outer JSON code: 200. The data object contains statement entries and pagination metadata. The following example uses illustrative identifiers and values.

{
  "code": 200,
  "message": "success",
  "data": {
    "statements": [
      {
        "txn_id": "demo-pix-txn-003",
        "amount": "25.00",
        "memo": "Demo supplier payment",
        "created_at": 1767225600000,
        "settlement_id": "demo-settlement-003",
        "payment_method": 1,
        "payment_variant": 1,
        "is_credit": false,
        "txn_status": 2,
        "txn_type": 1,
        "parent_txn_id": "",
        "parent_settlement_id": "",
        "payer": null,
        "payee": null
      }
    ],
    "snapshot_timestamp": 1767225600000,
    "cursor": {
      "timestamp": 1767225600000,
      "id": "demo-cursor-001",
      "direction": 1
    }
  },
  "time": 1767225600000
}

Result structure

Field inside `data`	JSON type	Description
`statements`	array	Transaction ledger entries for the selected account.
`snapshot_timestamp`	number	Snapshot timestamp returned with the result set.
`cursor`	object	Continuation metadata with numeric `timestamp`, string `id`, and numeric `direction`. Preserve the returned values.

Results are requested in descending order. This endpoint does not populate a page field; use the cursor metadata rather than relying on a page number.

Statement fields

Each object in statements[] can contain the following documented fields.

Field	JSON type	Description
`txn_id`	string	Transaction identifier.
`settlement_id`	string	Settlement identifier.
`amount`	string	Monetary value of the entry as a decimal string.
`memo`	string	Transaction memo.
`created_at`	number	Transaction creation timestamp.
`is_credit`	boolean	`true` for a credit; `false` for a debit, relative to the selected account.
`payment_method`	number	Payment method enum.
`payment_variant`	number	Payment variant enum.
`txn_status`	number	Transaction status enum.
`txn_type`	number	Transaction type enum.
`parent_txn_id`	string	Parent transaction reference, when present.
`parent_settlement_id`	string	Parent settlement reference, when present.
`payer`	object or null	Payer information when provided.
`payee`	object or null	Payee information when provided.

Keep amount as a decimal string or use a fixed-point/arbitrary-precision decimal library. Do not convert monetary values to binary floating-point numbers.

Credit and debit interpretation

is_credit is determined by comparing the transaction payee document with the selected account document. Interpret the direction relative to that account. In the example, is_credit: false identifies a debit entry with an amount of "25.00".

Payment methods, statuses, and party information

payment_method, payment_variant, txn_status, and txn_type are numeric enums. Use Objects & Enums for their meanings; the outer success code describes the API call, while txn_status describes the transaction.Party documents can be masked by merchant configuration. Handle the returned payer and payee values accordingly; both are null in the example.

Continue through results

Request the initial result set

Supply the required date range and any filters. Omit cursor for the initial request.

Read the continuation metadata

Process statements[] and retain the complete returned cursor object, including timestamp, id, and direction, along with snapshot_timestamp.

Build and sign the continuation request

To continue the same query, keep the account, date range, and filters consistent. Copy the complete returned cursor into the next request body. If you use snapshot_timestamp, preserve the returned value for the same query. Sign that new body with a fresh timestamp and nonce.

The confirmed pagination flow copies the previous response’s entire cursor object into the next request. Do not reconstruct the cursor from the last visible statement or increment a page number instead. The body below illustrates continuation using the response example above. Use the actual values returned by your request instead of these sample cursor values.

{
  "start_date": 1767139200000,
  "end_date": 1767225600000,
  "page_size": 20,
  "funds_type": 2,
  "snapshot_timestamp": 1767225600000,
  "cursor": {
    "timestamp": 1767225600000,
    "id": "demo-cursor-001",
      "direction": 1
  }
}

Errors

Check the outer JSON code to determine whether the API call succeeded. HTTP 200 alone does not indicate success. The following are endpoint-specific API result codes, not HTTP status codes.

API result code	Meaning on this endpoint	Next check
`4001`	Invalid dates or page size.	Supply non-zero millisecond timestamps with `start_date` earlier than `end_date`; keep `page_size` between `1` and `100`.
`4003008`	Missing account context.	Verify the credential and the required account-target headers.
`501`	Transaction-list RPC failure.	Record the response and follow the Error Catalog guidance for downstream failures.

The operation can also return mapped upstream errors or fail because of missing or invalid signing headers, an expired timestamp, nonce replay, a content-hash or signature mismatch, or insufficient permission.

Error Catalog

Interpret shared API result codes and transport errors.

Get Bank Account

Retrieve current balances, PIX keys, and account configuration.

Getting started

API Reference

Authentication & headers

Select the target account

Send the request headers

Request body

Date range and page size

Optional filters

Request

Success response

Result structure

Statement fields

Continue through results

Errors

Error Catalog

Get Bank Account

​Authentication & headers

​Select the target account

​Send the request headers

​Request body

​Date range and page size

​Optional filters

​Pagination inputs

​Request

​Success response

​Result structure

​Statement fields

​Continue through results

​Errors

Error Catalog

Get Bank Account

Authentication & headers

Select the target account

Send the request headers

Request body

Date range and page size

Optional filters

Pagination inputs

Request

Success response

Result structure

Statement fields

Continue through results

Errors