Skip to main content
GET
Export wallets
One row per wallet, with the columns Carteira (name — Carteira Empresarial for the organization’s main wallet), Responsável (the wallet’s OWNER), Tipo (Empresarial, Individual, Compartilhada or Veículo), Status (ATIVO for an ACTIVE wallet, DESATIVADO otherwise) and Saldo (the total balance in reais, formatted as 1.234,56, or - when it can’t be read). The CSV starts with a byte-order mark; the XLSX workbook comes base64-encoded. An export with no wallet has a single row of -. Organization admins export every wallet of the organization — of every account; other users only the wallets shared with them. Filter by status. Send x-environment: LIVE for production wallets.

Headers

x-environment
enum<string>

Environment whose wallets you export: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST wallets; 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 whose wallets you export.

Format: UUID

accountId
string
required

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

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

Query Parameters

status
enum<string>

Only wallets in this status (case-insensitive). Omit it to export every wallet.

Available options:
PENDING,
ACTIVE,
CANCELLING,
CANCELLED,
BLOCKED,
REPROVED,
FRAUD_ANALYSIS,
FRAUD_CONFIRMED
type
enum<string>

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

Available options:
csv,
xlsx

Response

application/csv — The CSV file, when type is csv or omitted.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet — The XLSX workbook, base64-encoded, when type is xlsx.

The CSV file, when type is csv or omitted.