> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List the realm's wallets > Lists the wallets of every organization of the realm, newest first. Each wallet comes without its name, users, settings and kind — read a wallet for those. Filter by `status` and `type`, which take their values comma-separated (`?status=ACTIVE,BLOCKED`), and page with `limit` + `next`. Wallets of the other environment are not listed, so send `x-environment: LIVE` for production wallets. ## OpenAPI ````yaml /api-reference/banking.openapi.json get /realms/{realmId}/wallets openapi: 3.0.3 info: title: Banking version: 1.0.0 description: >- Portão 3 banking API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Banking attaches a zod validationSchema at the route; request bodies are resolved from it (object + array roots). Responses have no presenter layer, so they stay tier=unknown. Confidence tiers: generated:typed=262 copied:manual=1 unknown=35. servers: - url: https://api.banking.v2.portao3.com.br/ description: production - url: https://api.banking.dev.3pers.com.br/ description: development security: [] tags: - name: Accounts - name: Account Limits - name: Wallets - name: Transaction Limits - name: Transfers - name: Cards - name: Card Limits - name: Cards 3DS - name: Pix Payments - name: PIX Keys (DICT) - name: PIX Charges - name: PIX Automatic - name: PIX Initiation (Open Finance) - name: PIX Infractions (MED) - name: Boleto Payments - name: Boleto Charges - name: TED - name: Transactions - name: Cashback - name: Currency Codes - name: Reversals paths: /realms/{realmId}/wallets: get: tags: - Wallets summary: List the realm's wallets description: Lists the wallets of every organization of the realm, newest first. operationId: getRealmsByRealmIdWallets parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: x-environment in: header required: false description: >- Environment whose wallets you list: `LIVE` (production) or `TEST` (sandbox). When you omit it, you get the `TEST` wallets; any other value is rejected. schema: type: string enum: - LIVE - TEST example: LIVE - name: status in: query required: false description: >- Only wallets in these statuses (case-insensitive): `PENDING`, `ACTIVE`, `BLOCKED`, `CANCELLING`, `CANCELLED`, `REPROVED`, `FRAUD_ANALYSIS` or `FRAUD_CONFIRMED`. Other values match no wallet. --- Example (comma-separated list): `?status=ACTIVE,BLOCKED` schema: type: array items: type: string maxLength: 64 style: form explode: false - name: type in: query required: false description: >- Only wallets of these kinds (case-insensitive): `ORGANIZATION`, `SHARED`, `PERSONAL` or `VEHICLE`. Other values match no wallet. --- Example: `?type=ORGANIZATION` schema: type: array items: type: string maxLength: 64 style: form explode: false - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit it for the first page. schema: type: string example: NjZmMmEzZDFiNGQzZTgwMDEyYzlhMGQy - name: limit in: query required: false description: Page size. Defaults to 15. schema: type: integer minimum: 0 exclusiveMinimum: true example: 15 responses: '200': description: Successful response content: application/json: schema: type: object properties: items: type: array items: type: object properties: _id: type: string description: ID of the wallet. example: 66f2a3d1b4d3e80012c9a0d2 realmId: type: string description: ID of the realm the wallet belongs to. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization the wallet belongs to. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid accountId: type: string description: ID of the account the wallet belongs to. example: 66f2a1c7b4d3e80012c9a0b4 environment: type: string enum: - LIVE - TEST description: >- Environment the wallet lives in: `LIVE` (production) or `TEST` (sandbox). example: LIVE external: type: object properties: balanceAccountGroupId: type: string description: >- Internal identifier of the wallet at the bank. Absent while the wallet is being created. example: 4f6b0e1d-2b3a-4c5d-8e9f-0a1b2c3d4e5f accountNumber: type: number nullable: true description: >- Number of the wallet's bank account. Absent, or `null`, while the wallet is being created. example: 10023456 branch: type: string description: Branch of the wallet's bank account. example: '0001' accountType: type: string nullable: true enum: - PREPAID - CCLG - null description: >- Type of the wallet's bank account: `PREPAID` (a prepaid payment account) or `CCLG` (a postpaid account). example: PREPAID description: >- The wallet's bank account. Absent on a few wallets created before it was recorded. currency: type: string description: >- Currency of the wallet, as an ISO 4217 numeric code. Always `986` (Brazilian real). example: '986' customFields: type: object additionalProperties: {} description: >- Values of the organization's wallet custom fields, keyed by each field's `slug`. Absent when the wallet has none. --- Example: `{"cost-center":"CC-1020"}` example: cost-center: CC-1020 status: type: string enum: - PENDING - ACTIVE - CANCELLING - CANCELLED - BLOCKED - REPROVED - FRAUD_ANALYSIS - FRAUD_CONFIRMED description: >- Status of the wallet: `PENDING`, `ACTIVE`, `BLOCKED`, `CANCELLING`, `CANCELLED`, `REPROVED`, `FRAUD_ANALYSIS` or `FRAUD_CONFIRMED` — see the wallet's own read for what each means. example: ACTIVE role: type: string description: >- Role of the wallet in the account: `DEFAULT` for the organization's main wallet and `CHECKING` for every other wallet. A few older wallets carry another value. example: CHECKING walletProduct: type: string description: >- Card product of the wallet, inherited from the account. Absent on older wallets. example: NORMAL isSuper: type: boolean description: >- Whether the wallet's cards are on the premium card product. example: false createdBy: type: string nullable: true description: >- ID of the user who created the wallet. Absent, or `null`, on older wallets. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid updatedBy: type: string nullable: true description: >- ID of the user who created the wallet; editing it doesn't change this field. Absent, or `null`, on older wallets. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid accountType: type: string enum: - PREPAID - CCLG description: >- Type of the wallet's bank account, on older wallets only: the same as `external.accountType`. example: PREPAID createdAt: type: string description: When the wallet was created. example: '2024-10-01T12:30:05.000Z' format: date-time updatedAt: type: string description: When the wallet last changed. example: '2024-10-01T12:34:41.000Z' format: date-time __v: type: number description: Internal revision counter of the wallet. example: 0 required: - _id - realmId - organizationId - accountId - environment - currency - status - role - isSuper - createdAt - updatedAt description: >- A wallet in a list that leaves out its name, users, settings and kind: read the wallet itself for those. description: The wallets of this page, newest first. next: type: string nullable: true description: >- Cursor of the next page: send it as `next` to read it. `null` on the last page. example: NjZmMmEzZDFiNGQzZTgwMDEyYzlhMGQy required: - items - next description: A page of wallets. '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: BANKING message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: limit message: 'Invalid input: expected integer, received string' code: LIMIT_TYPE_ERROR ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.