Skip to main content
GET
Get a wallet's transaction totals
startDate and endDate are required. Narrow the totals with the same filters as the wallet’s transactions list — financialImpactType, transactionTypes, cardId and internalTransaction — to match a filtered list. Use default as walletId for the organization’s main wallet, and send x-environment: LIVE for production wallets. Organization admins can read every wallet’s totals; other users only those of the wallets shared with them, in any role.

Headers

x-environment
enum<string>

Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, you get the totals of 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 wallet belongs to.

Format: UUID

accountId
string
required

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

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

ID of the wallet (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$

Query Parameters

startDate
string
required

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).

endDate
string
required

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
enum<string>[]

Only transactions with these effects on the balance (case-insensitive, comma-separated for several): DEBIT, CREDIT or NONE. NONE transactions move no money, so they add nothing to the totals.


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

Available options:
DEBIT,
CREDIT,
NONE
transactionTypes
enum<string>[]

Only transactions of these kinds (case-insensitive, comma-separated for several): CARD, PIX, BOLETO, FEE or P2P (transfers between wallets at Portão 3). TED transfers have no kind here: they count only when you send no transactionTypes.


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

Available options:
CARD,
PIX,
BOLETO,
FEE,
P2P
cardId
string[]

Only the transactions of these cards of the wallet (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

Response

Successful response

Totals of the transactions in a period.

input
number
required

Sum of the CREDIT transactions (money in), in cents (BRL).

Example:

1520000

output
number
required

Sum of the DEBIT transactions (money out), in cents (BRL).

Example:

984320