> ## 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 a wallet's Pix Automatic authorizations > Lists the wallet's Pix Automático authorizations, newest first. Filter by the payer — `debitPartyDocument`, `debitPartyEmail` and `debitPartyName` each match part of the value —, by `description`, by `status` and `scheduleType`, which take their values comma-separated (`?status=SCHEDULED,CREATED`), and by the amount and date ranges of the first payment and of the recurrence. Page with `limit` + `next`. Only the authorizations of the environment in `x-environment` are listed, so send `x-environment: LIVE` for production ones. An unknown wallet has none. The items don't carry their charges: read an authorization by ID for them. Use `default` as `walletId` for the organization's main wallet. Any member of the organization can list them. ## OpenAPI ````yaml /api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic 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=320 copied:manual=0 unknown=8. 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 - name: PIX Charges - name: PIX Automatic - name: PIX Initiation (Open Finance) - name: PIX Infractions (MED) - name: Boleto Payments - name: Boleto Billing - name: TED Payments - name: Transactions - name: Transaction Reversals - name: Spend Review - name: Cashback - name: Currency Codes paths: /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic: get: tags: - PIX Automatic summary: List a wallet's Pix Automatic authorizations description: Lists the wallet's Pix Automático authorizations, newest first. operationId: >- getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomatic 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. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: accountId in: path required: true description: ID of the organization's account (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 66f2a1c7b4d3e80012c9a0b4 - name: walletId in: path required: true description: >- ID of the wallet that receives the payments (24 hexadecimal characters), or `default` for the organization's main wallet. schema: type: string pattern: ^([0-9a-fA-F]{24}|default)$ example: 66f2a3d1b4d3e80012c9a0d2 - name: x-environment in: header required: false description: >- Environment whose authorizations you list: `LIVE` (production) or `TEST` (sandbox). When you omit it, you get the `TEST` ones; any other value is rejected. schema: type: string enum: - LIVE - TEST example: LIVE - name: debitPartyDocument in: query required: false description: >- Only authorizations whose payer's CPF or CNPJ contains this text (digits only, as stored). schema: type: string maxLength: 256 example: '12345678909' - name: debitPartyEmail in: query required: false description: >- Only authorizations whose payer's e-mail contains this text, ignoring case. schema: type: string maxLength: 256 example: juliana.ribeiro@exemplo.com.br - name: debitPartyName in: query required: false description: >- Only authorizations whose payer's name contains this text, ignoring case. schema: type: string maxLength: 256 example: Juliana - name: description in: query required: false description: >- Only authorizations whose description contains this text, ignoring case. schema: type: string maxLength: 256 example: Mensalidade - name: status in: query required: false description: >- Only authorizations in these statuses (case-insensitive): `CREATED`, `INITIATED`, `SCHEDULED`, `CANCELED`, `EXPIRED`, `REVOKED` or `FAILED`. --- Example (comma-separated list): `?status=SCHEDULED,CREATED` schema: type: array items: type: string enum: - CREATED - INITIATED - SCHEDULED - CANCELED - EXPIRED - REVOKED - FAILED style: form explode: false - name: scheduleType in: query required: false description: >- Only authorizations with these frequencies (case-insensitive): `WEEKLY`, `MONTHLY`, `QUARTERLY`, `SEMESTER` or `YEARLY`. --- Example (comma-separated list): `?scheduleType=MONTHLY,YEARLY` schema: type: array items: type: string enum: - WEEKLY - MONTHLY - QUARTERLY - SEMESTER - YEARLY style: form explode: false - name: firstPaymentAmountMin in: query required: false description: >- Only authorizations whose first payment is at least this amount, in cents. schema: type: number minimum: 0 exclusiveMinimum: true example: 10000 - name: firstPaymentAmountMax in: query required: false description: >- Only authorizations whose first payment is at most this amount, in cents. Not less than `firstPaymentAmountMin`. schema: type: number minimum: 0 exclusiveMinimum: true example: 50000 - name: scheduleAmountMin in: query required: false description: >- Only authorizations whose `schedule.minAmount` is at least this amount, in cents. schema: type: number minimum: 0 exclusiveMinimum: true example: 10000 - name: scheduleAmountMax in: query required: false description: >- Only authorizations whose `schedule.maxAmount` is at most this amount, in cents. Not less than `scheduleAmountMin`. schema: type: number minimum: 0 exclusiveMinimum: true example: 50000 - name: firstPaymentStartDate in: query required: false description: >- Only authorizations whose first payment is on or after this date: an ISO 8601 date (`2026-11-01`, midnight UTC) or date-time. schema: type: string example: '2026-11-01' - name: firstPaymentEndDate in: query required: false description: >- Only authorizations whose first payment is on or before this date, in the same format. Not before `firstPaymentStartDate`. schema: type: string example: '2026-11-30' - name: scheduleStartDate in: query required: false description: >- Only authorizations whose authorization starts (`schedule.startDate`) on or after this date, in the same format. schema: type: string example: '2026-12-01' - name: scheduleEndDate in: query required: false description: >- Only authorizations whose authorization ends (`schedule.endDate`) on or before this date, in the same format. Not before `scheduleStartDate`. schema: type: string example: '2027-12-31' - 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: NjcyOWYzZTFiNGQzZTgwMDEyYzlhN2Mx - 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 authorization. Use it as `{pixBillingAutomaticId}`. example: 6729f3e1b4d3e80012c9a7c1 environment: type: string enum: - LIVE - TEST description: >- Environment of the authorization: `LIVE` (production) or `TEST` (sandbox). example: LIVE realmId: type: string description: ID of the realm. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid accountId: type: string description: ID of the organization's account. example: 66f2a1c7b4d3e80012c9a0b4 walletId: type: string description: ID of the wallet that receives the money. example: 66f2a3d1b4d3e80012c9a0d2 pixDict: type: string description: The wallet's Pix key the payments go to. example: financeiro@academiamovimento.com.br status: type: string enum: - CREATED - INITIATED - SCHEDULED - CANCELED - EXPIRED - REVOKED - FAILED description: >- Where the authorization stands: - `CREATED` — waiting for the payer to open `paymentUrl` and grant it in their bank. - `INITIATED` — the payer started the authorization. - `SCHEDULED` — the payer granted it; the charges follow `schedules`. It stays `SCHEDULED` after the last charge. - `CANCELED` — you canceled it. - `REVOKED` — the payer revoked it in their bank; the pending charges were canceled. - `EXPIRED` — the payer didn't grant it before the first charges were due. - `FAILED` — not used today. example: SCHEDULED description: type: string description: >- Description of the authorization, shown to the payer. It is also the description of each recurring charge. example: Mensalidade Academia Movimento debitParty: type: object properties: type: type: string enum: - INDIVIDUAL - BUSINESS description: >- `INDIVIDUAL` for a person (a CPF in `document`) or `BUSINESS` for a company (a CNPJ). example: INDIVIDUAL name: type: string description: Name of the payer. example: Juliana Ribeiro email: type: string description: E-mail of the payer. example: juliana.ribeiro@exemplo.com.br document: type: string description: CPF or CNPJ of the payer, digits only. example: '12345678909' required: - type - name - email - document description: The payer. paymentUrl: type: string description: >- Link where the payer reviews the authorization and grants it in their bank. Send it to the payer. example: >- https://pay.portao3.com.br/2d902e74-7ca0-4f6c-9c83-4b5e6f708192 paymentLinkValidity: type: string nullable: true description: >- Until when `paymentUrl` can be used — the end of the authorization. `null` when it isn't known. example: '2027-11-11T03:00:00.000Z' format: date-time schedule: type: object properties: type: type: string enum: - WEEKLY - MONTHLY - QUARTERLY - SEMESTER - YEARLY description: >- How often the recurring charges happen: `WEEKLY`, `MONTHLY`, `QUARTERLY` (every 3 months), `SEMESTER` (every 6 months) or `YEARLY`. example: MONTHLY minAmount: type: number description: >- Smallest amount a recurring charge can have, in cents. Each recurring charge is created with this amount. example: 18990 maxAmount: type: number description: >- Largest amount a recurring charge can have, in cents — the most the payer authorizes per charge. example: 18990 startDate: type: string description: >- When the authorization starts: two days before the `schedule.startDate` you sent — or the day after the first payment, when that is later. Midnight UTC of that day. example: '2026-12-08T00:00:00.000Z' format: date-time endDate: type: string description: >- When the authorization ends: the day after the `schedule.endDate` you sent, at midnight UTC. No charge can be made after it. example: '2027-11-11T00:00:00.000Z' format: date-time required: - type - minAmount - maxAmount - startDate - endDate description: The recurrence the payer authorizes. firstPayment: type: object properties: _id: type: string description: ID of the first payment's record. example: 6729f3e1b4d3e80012c9a7c2 amount: type: number description: Amount of the first payment, in cents. example: 18990 date: type: string description: Day of the first payment, at midnight UTC. example: '2026-11-10T00:00:00.000Z' format: date-time description: type: string description: >- Description of the first payment, when you sent one. example: Primeira mensalidade required: - _id - amount - date description: The first payment, when you asked for one. external: type: object properties: customerId: type: string description: The institution's ID of the payer. example: 0b7e0c52-5a8e-4d4a-9a61-2f3c4d5e6f70 recipientId: type: string description: >- The institution's ID of the receiving account — your wallet. example: 1c8f1d63-6b9f-4e5b-8b72-3a4d5e6f7081 requestId: type: string description: >- The institution's ID of the request. It is also the last part of `paymentUrl`. example: 2d902e74-7ca0-4f6c-9c83-4b5e6f708192 description: References at the payment institution. createdAt: type: string description: When the authorization was created. example: '2026-11-05T14:20:31.402Z' format: date-time updatedAt: type: string description: When the authorization last changed. example: '2026-11-05T14:31:07.118Z' format: date-time __v: type: number description: Internal revision counter of the record. example: 0 required: - _id - environment - realmId - organizationId - accountId - walletId - pixDict - status - debitParty - paymentUrl - schedule - external - createdAt - updatedAt description: >- A Pix Automático authorization: the payer's consent, given in their bank, for the wallet to charge their account on a schedule, without a new approval for each charge. description: The authorizations 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: NjcyOWYzZTFiNGQzZTgwMDEyYzlhN2Mx required: - items - next description: A page of authorizations. '404': description: >- `ACCOUNT_NOT_FOUND` — With `walletId` `default`: no account with this ID exists in the organization. `WALLET_NOT_FOUND` — With `walletId` `default`: the account has no main wallet in this environment. 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: - ACCOUNT_NOT_FOUND - WALLET_NOT_FOUND 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: ACCOUNT_NOT_FOUND origin: BANKING message: Account not found '422': description: >- `BAD_REQUEST` — A path or query parameter is invalid — for example a minimum above its maximum; `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: debitPartyDocument message: 'Too big: expected string to have <=256 characters' code: DEBITPARTYDOCUMENT_MAX ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.