Account statement

Use the statement to check transactions recorded in the account and reconcile amounts with your system. Each item is a financial entry; a payment can generate an incoming amount and a fee as separate items.

View transactions

Use Retrieve account statement, with GET /v1/statements. You can query a period, select entry types or filter by a linked reference. Combine filters according to the query you need.

Dates use Unix seconds in UTC. created_gte includes entries from the specified instant onward, and created_lte includes entries up to that instant. The default order shows newest entries first; sort_order: asc shows oldest entries first.

The query returns history recorded by Raims. It does not initiate payments, withdrawals, refunds or balance releases. A request still in progress may not have its financial result in the statement; also track the resource that originated the request.

View a statement entry

Use Retrieve a statement entry, with GET /v1/statements/{id}, to check an item without navigating through statement pages again. Send the complete identifier with the st_ prefix returned in the list.

The response contains the same fields as a list item. An entry that is missing or does not belong to the company and environment of the key receives the same resource not found response.

Entry types and amounts

amount_cents shows the amount in Brazilian real cents, preserving its sign: 10000 represents R$100.00, and -250 represents a debit of R$2.50. Interpret the amount together with statement_type. The entry types guide explains all codes, amount signs and considerations for each case.

Holds and releases record changes in money availability. A release does not represent a new receipt. The statement does not show the account balance after each entry; adding up a page or only filtered items does not provide the current balance.

To view the current balance, use Balance. It distinguishes the account total, the held portion and the available amount.

Links to other resources

id, with the st_ prefix, identifies the entry so your system can recognize it. reference_id identifies the source resource when a link is available. reference_type shows the category of that reference: charge (1), dispute (2), withdrawal (3), adjustment (4) or manual entry (5). Fields without an available link are null. See the identifiers and prefixes guide to distinguish IDs, including references without their own public endpoint.

When the reference is a withdrawal, copy the wd_ ID to Retrieve a withdrawal. The query shows progress and the recorded destination without requesting another transfer.

refund_id identifies the refund request linked to the entry, when available. dispute_id identifies the corresponding dispute, including MED cases. Use these fields to view the source refund or dispute.

These fields are null when no link is confirmed. A fee or another entry for the same charge does not automatically receive the refund or dispute ID. Keep the returned IDs, including their prefixes, when querying each resource.

Use Charges and Disputes to track the corresponding resources. The entry identifier differs from the charge or dispute identifier. The presence of a reference does not mean that a public endpoint exists to query every category.

Navigate the history

The response contains list, with the entries on the page, and page, with navigation details. Start without a cursor and process the items in list. While page.has_next is true, copy the entire page.next_after to after in the next request.

Keep the same key, filters and sorting throughout navigation. To change the query, start again without a cursor. An empty list means that the page has no entries for the specified filters.

To go back, use page.previous_before in before. Do not send populated after and before together or interpret cursor contents. See Listing and pagination for the general rules.

Company and environment

Queries require an API key. The company and environment come from that key: Sandbox queries only simulated transactions; Production queries the corresponding financial history. This documentation console accepts only Sandbox keys.

Filtering by a reference does not grant access to another company or environment. Handle errors by HTTP status and error.code; for validation errors, also check the fields indicated in error.details.