> ## 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 wallets > Lists the organization's wallets, with their balances. Organization admins see every wallet of the organization; other users see only the wallets shared with them, in any role. On the first page with no filter and no `orderBy`, your own `PERSONAL` wallet comes first. Wallets of the other environment are not listed, so send `x-environment: LIVE` for production wallets. Filter by `name` (ignoring case — every word in any order for organization admins, the text as typed for other users), `status`, `types`, `walletProducts`, `accountId`, `ids` or `excludeIds`; admins can also filter by `ownerIds` and `sharedUserId`. List filters take their values comma-separated (`?status=ACTIVE,BLOCKED`); repeating the parameter works too. Sort with `orderBy` + `order` and page with `limit` + `next`. The balances are read live; send `includeBalances=false` to leave them out, which is faster. A wallet whose balance can't be read at that moment comes without it. ## OpenAPI ````yaml /api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/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}/organizations/{organizationId}/wallets: get: tags: - Wallets summary: List wallets description: Lists the organization's wallets, with their balances. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdWallets 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: organizationId in: path required: true description: |- ID of the organization whose wallets you list. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - 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: name in: query required: false description: >- Only wallets whose name contains this text, ignoring case. For organization admins every word counts on its own, in any order; for other users the text must appear as typed. schema: type: string maxLength: 256 example: marketing - 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: types in: query required: false description: >- Only wallets of these kinds (case-insensitive): `ORGANIZATION`, `SHARED`, `PERSONAL` or `VEHICLE`. Other values match no wallet. --- Example (comma-separated list): `?types=SHARED,PERSONAL` schema: type: array items: type: string maxLength: 64 style: form explode: false - name: walletProducts in: query required: false description: |- Only wallets on these card products. --- Example (comma-separated list): `?walletProducts=NORMAL,SUPER` schema: type: array items: type: string style: form explode: false - name: ownerIds in: query required: false description: >- Only wallets whose `OWNER` is one of these users. Organization admins only: anyone else gets a `403`. --- Example (comma-separated list): `?ownerIds=e3553bc1-5e20-4e17-b22a-a796fda0aa99,0b6f2c1e-8d4a-4f3b-9a7e-5c2d1e0f9a8b` schema: type: array items: type: string style: form explode: false - name: sharedUserId in: query required: false description: >- Only wallets shared with this user, in any role. Organization admins only; ignored for anyone else. schema: type: string example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 - name: accountId in: query required: false description: >- Only wallets of this account. A value that isn't an account ID matches no wallet. schema: type: string example: 66f2a1c7b4d3e80012c9a0b4 - name: ids in: query required: false description: >- Only these wallets. Values that aren't wallet IDs match no wallet. --- Example (comma-separated list): `?ids=66f2a3d1b4d3e80012c9a0d2,66f2a1d0b4d3e80012c9a0b9` schema: type: array items: type: string style: form explode: false - name: excludeIds in: query required: false description: >- Leave these wallets out. Values that aren't wallet IDs are ignored. --- Example (comma-separated list): `?excludeIds=66f2a1d0b4d3e80012c9a0b9,6710b8e4c9e77b0012a4d6f3` schema: type: array items: type: string style: form explode: false - name: orderBy in: query required: false description: >- Field to sort by: `createdAt` (the default), `name`, or another wallet field such as `updatedAt`. schema: type: string example: name - name: order in: query required: false description: Sort direction of `orderBy` (case-insensitive). Defaults to `DESC`. schema: type: string enum: - ASC - DESC example: ASC - name: includeBalances in: query required: false description: >- `false` returns the wallets without their balances, which is faster. Balances are included by default. schema: type: string enum: - 'true' - 'false' example: '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 for organization admins and 20 for other users. Your `PERSONAL` wallet, when it leads the first page, takes one of those slots — except with `limit=1`, or when an admin omits `limit`, where that page holds one more. schema: type: integer minimum: 0 exclusiveMinimum: true example: 20 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`. --- 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 type: type: string enum: - PERSONAL - SHARED - ORGANIZATION - VEHICLE description: >- Kind of wallet: `ORGANIZATION`, `SHARED`, `PERSONAL` or `VEHICLE`. example: SHARED name: type: string nullable: true description: >- Name of the wallet. Absent on older wallets created without one. example: Marketing shared: type: array items: type: object properties: _id: type: string description: Internal identifier of this entry. example: 66f2a3d1b4d3e80012c9a0d3 id: type: string description: ID of the user. example: e3553bc1-5e20-4e17-b22a-a796fda0aa99 format: uuid firstName: type: string description: >- First name of the user, as it was when they were given access. example: Mariana lastName: type: string description: >- Last name of the user, as it was when they were given access. example: Costa email: type: string description: >- E-mail of the user, as it was when they were given access. example: mariana.costa@acme.com.br role: type: string enum: - OWNER - USER - READ_ONLY description: >- What the user can do with the wallet: `OWNER` and `USER` both use it and can edit it — its users included; `READ_ONLY` only sees it. Creating or editing a wallet's users requires at least one `OWNER`. example: OWNER required: - id - role description: A user who can use the wallet. description: >- Users who can use the wallet, and how. Absent on older wallets shared with no one. settings: type: object properties: payment: type: object properties: pix: type: boolean description: >- Whether PIX payments can be sent from the wallet. The organization's main wallet ignores it. example: true bankSlip: type: boolean description: >- Whether boletos can be paid from the wallet. The organization's main wallet ignores it. example: true card: type: boolean description: >- Whether new cards can be issued for the wallet. Cards it already has keep working. example: true description: Which payment methods the wallet can use. notification: type: object properties: balanceLimit: type: object properties: amount: type: number description: >- Balance below which the alert fires, in cents. example: 50000 email: type: boolean description: >- Whether the alert is also sent by e-mail. example: true isActive: type: boolean description: Whether the alert is on. example: true required: - amount - email - isActive description: The wallet's low-balance alert. required: - balanceLimit description: >- Notification settings. Only some older wallets have them. description: >- Settings of the wallet. Absent on older wallets created without them. 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. Absent on older wallets. 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 totalBalance: type: number description: >- Total balance of the wallet across all of its categories — `BLOCKED` and `CASHBACK` included — in cents. Absent with `includeBalances=false`, and when the balance can't be read at that moment. example: 1250000 balances: type: array items: type: object properties: category: type: string enum: - FLEX_NATIONAL - FLEX_INTERNATIONAL - FOOD - GAS - MOBILITY - TOLL - FLEX_NATIONAL_WITHOUT_WITHDRAWALS - ADS - SAAS - HOTEL - AIRLINES - TRAVEL - BLOCKED - CASHBACK description: >- Balance category. `FLEX_INTERNATIONAL` is the general-purpose category most flows use; `FOOD`, `GAS`, `MOBILITY`, `TOLL`, `ADS`, `SAAS`, `HOTEL`, `AIRLINES` and `TRAVEL` can only be spent on their kind of purchase; `BLOCKED` holds funds that can't be spent; `CASHBACK` holds cashback earned. example: FLEX_INTERNATIONAL amount: type: number description: Balance of the category, in cents. example: 1250000 required: - category - amount description: The balance of one category of the wallet. description: >- Balance per category. Absent with `includeBalances=false`, and when the balance can't be read at that moment. required: - _id - realmId - organizationId - accountId - environment - currency - status - createdAt - updatedAt description: >- A wallet of the organization's list. The list reads wallets as they are stored, so keys an older wallet never had are absent rather than defaulted. description: The wallets of this page. 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 the organization's wallets. '403': description: >- `FORBIDDEN_WALLET` — You sent `ownerIds` and are not an admin of the organization. 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: - FORBIDDEN_WALLET 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. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: FORBIDDEN_WALLET origin: BANKING message: >- You do not have permission to perform this action on this wallet '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: name message: 'Too big: expected string to have <=256 characters' code: NAME_MAX ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.