Skip to main content
GET
List an account's transactions
Narrow it to a period with startDate and endDate (both, or neither), to a wallet with walletId, to a card with cardId, by effect on the balance with financialImpactType or by kind with transactionTypes, and page with limit + next. description and debitParty search by text instead (see each). Every item comes with a one-line Portuguese description. Send x-environment: LIVE for production transactions. Only organization admins can list the whole account; other users list the wallets shared with them with GET .../wallets/{walletId}/transactions.

Headers

​
x-environment
enum<string>

Environment of the transactions: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST transactions; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

​
realmId
string<uuid>
required

ID of your realm.

Format: UUID

​
organizationId
string<uuid>
required

ID of the organization the account belongs to.

Format: UUID

​
accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

​
startDate
string

Start of the period, inclusive, compared with each transaction's effectiveAt: an ISO 8601 date-time (2026-11-01T03:00:00.000Z) or date (2026-11-01, read as midnight UTC). The period applies only when you send both startDate and endDate.

​
endDate
string

End of the period, inclusive, in the same format as startDate. A date alone (2026-11-30) is midnight UTC at the start of that day, so the rest of the day is left out.

​
financialImpactType
string[]

Only transactions with these effects on the balance (case-insensitive, comma-separated for several): DEBIT (money out), CREDIT (money in) or NONE (no effect, such as a declined card purchase or a failed transfer). Other values match no transaction.

Example (comma-separated list): ?financialImpactType=DEBIT,CREDIT

Maximum string length: 64
​
transactionTypes
enum<string>[]

Only transactions of these kinds (case-insensitive, comma-separated for several): CARD (card purchases, their settlements and refunds), PIX (Pix sent and received, and their refunds), BOLETO (boletos paid and received), FEE (fees) or P2P (transfers between wallets at Portão 3). TED transfers have no kind here: they are listed only when you send no transactionTypes.

Example (comma-separated list): ?transactionTypes=PIX,BOLETO

Available options:
CARD,
PIX,
BOLETO,
FEE,
P2P
​
description
string

Only transactions whose card merchant name, Pix counterparty name, boleto payee or payer, or fee description contains this text. When you send it, debitParty is ignored.

Maximum string length: 256
​
debitParty
string

Only Pix whose payer has this CPF or CNPJ (digits only, as stored): the Pix received from them — or, with your own organization's document, the Pix you sent. Ignored when you also send description.

Maximum string length: 64
​
walletId
string

Only the transactions of this wallet of the account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
​
cardId
string[]

Only the transactions of these cards (24 hexadecimal characters each, comma-separated for several).

Example (comma-separated list): ?cardId=66f2a4b8b4d3e80012c9a0e1,66f2a4b8b4d3e80012c9a0e2

Pattern: ^[0-9a-fA-F]{24}$
​
internalTransaction
enum<string>

true for only the transfers between wallets at Portão 3 (P2P) — ignored when transactionTypes includes P2P, which then decides alone. false, like omitting it, applies no filter.

Available options:
true,
false
​
next
string

Cursor returned as next by the previous page, sent with the same filters. Omit it for the first page.

​
limit
integer

Page size. Defaults to 15 — 20 when you filter by description or debitParty. A page of 4,000 transactions or more is refused.

Required range: x > 0

Response

Successful response

A page of transactions.

​
items
object[]
required

The transactions of this page.

​
next
string | null
required

Cursor of the next page: pass it as next (with the same filters) to read it. null on the last page.

Example:

"NjcxMGM5YTJiNGQzZTgwMDEyYzlhMWU0"