Skip to main content
POST
Export an account's transactions by e-mail
The request only queues the export: it answers 204 (no body) right away, and the e-mail — to userToNotify.email — arrives once the file is ready, with a download link that expires (6 days after it is sent at the latest, so download it soon). The file holds one page of the account’s transactions list, newest first: send the same filters (startDate, endDate, walletId, cardId, financialImpactType, transactionTypes, internalTransaction, description, debitParty) and set limit to how many it may hold — it defaults to 15. Pick the format with type. Send x-environment: LIVE for production transactions. If the export fails after the request was accepted, no e-mail is sent. Only organization admins can export the account.

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), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$
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
type
enum<string>

Format of the file: csv (the default) or xlsx. Case-insensitive.

Available options:
csv,
xlsx
next
string

Cursor of a transactions list page (its next) to start the file after, sent with the same filters. Omit it to start at the newest transaction.

limit
integer

Most transactions the file holds, newest first. Defaults to 15 — 20 when you filter by description or debitParty — so send a larger value (such as 10000) for a full statement.

Required range: x > 0

Body

application/json
userToNotify
object
required

Who receives the e-mail with the download link. Any address you send gets it.

Response

No Content. The operation succeeded and the response has no body.