> ## 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 an authorization's charges > Lists the authorization's charges — the first payment and each recurring charge —, the most recently created first. Page with `limit` + `next`. Any other query parameter filters by the exact value of that field of the charge — for example `?status=PAID`. Only the charges of the environment in `x-environment` are listed, so send `x-environment: LIVE` for production ones. An unknown authorization has no charges: the page is empty. 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/{pixBillingAutomaticId}/schedules 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/{pixBillingAutomaticId}/schedules: get: tags: - PIX Automatic summary: List an authorization's charges description: >- Lists the authorization's charges — the first payment and each recurring charge —, the most recently created first. operationId: >- getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticByPixBillingAutomaticIdSchedules 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: pixBillingAutomaticId in: path required: true description: ID of the authorization — its `_id` (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 6729f3e1b4d3e80012c9a7c1 - name: x-environment in: header required: false description: >- Environment of the authorization: `LIVE` (production) or `TEST` (sandbox). When you omit it, `TEST` is used; any other value is rejected. schema: type: string enum: - LIVE - TEST example: LIVE - 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 charge. Use it as `{pixBillingAutomaticScheduleId}`. example: 6729f3e1b4d3e80012c9a7d4 environment: type: string enum: - LIVE - TEST description: >- Environment of the charge: `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 pixBillingAutomaticId: type: string description: ID of the authorization this charge belongs to. example: 6729f3e1b4d3e80012c9a7c1 amount: type: number description: Amount of the charge, in cents. example: 18990 status: type: string enum: - CREATED - SCHEDULED - CANCELED - EXPIRED - FAILED - SCHEDULE_ERROR - PAID - RETRY description: >- Where the charge stands: - `CREATED` — waiting. A recurring charge is sent to the payer's bank between 2 and 10 days before `scheduledTo`, once the payer has granted the authorization; until then you can change its amount. The first payment goes with the authorization itself and is charged when the payer grants it. A recurring charge still `CREATED` after its date: without `external.scheduleId`, the payer's bank most likely refused it when it was sent (its history has a `SCHEDULE_ATTEMPT_FAILED` event) — in rare cases the bank accepted it and the confirmation was lost, so confirm with support before charging it another way; with one, the bank is still processing it — wait for the outcome. - `SCHEDULED` — sent to the payer's bank, which debits it on `scheduledTo`. - `PAID` — paid; the money is in the wallet. - `FAILED` — the payer's bank couldn't debit it and it won't be tried again: a final refusal (for example, the payer's limit for the period was reached) or the new attempts ran out. `error` says why. - `SCHEDULE_ERROR` — it couldn't be sent to the payer's bank and won't be. `error` says why; treat it like `FAILED`. - `CANCELED` — canceled, by you or because the authorization was canceled or revoked. - `EXPIRED` — the payer never granted the authorization. - `RETRY` — not used today. example: SCHEDULED description: type: string description: Description of the charge. example: Mensalidade Academia Movimento isFirstPayment: type: boolean description: >- `true` for the first payment, absent for a recurring charge. example: true scheduledTo: type: string description: >- Day the charge is debited, at midnight UTC: its due date, or the date of the latest new attempt after a failure. example: '2026-12-10T00:00:00.000Z' format: date-time attempts: type: array items: type: object properties: _id: type: string description: ID of the attempt's record. example: 672c1f00b4d3e80012c9a9f1 attempt: type: number description: >- Number of the attempt: `1` for the one on the due date, then one more for each new attempt. example: 1 date: type: string description: Day of the attempt, at midnight UTC. example: '2026-12-10T00:00:00.000Z' format: date-time required: - _id - attempt - date description: >- One attempt to debit a charge: the first, on its due date, and each new one asked for after the payer's bank failed to debit it. description: >- The attempts to debit the charge, oldest first: the first, on `scheduledTo`, then each new attempt asked for after the payer's bank failed to debit it. external: type: object properties: scheduleId: type: string description: >- The institution's ID of the charge. Set once the charge is sent to the payer's bank. example: 3ea13f85-8db1-4a7d-8d94-5c6f708192a3 endToEndId: type: string description: >- End-to-end ID of the Pix that debits the charge, once the payment institution reports it. example: E00000000202612101203a1b2c3d4e5f scheduleAttemptsCount: type: number description: >- How many times the charge was sent to the payer's bank: `1`, plus one for each time it was sent again after a failure before the due date. example: 1 description: >- References at the payment institution, once the charge is sent to the payer's bank. error: type: object properties: code: type: string description: >- Code of the failure: a code of the Pix Automático rules — for example `LIMITE_PERIODO_VALOR_EXCEDIDO` (the payer's limit for the period was reached), `CONSENTIMENTO_REVOGADO` (the payer revoked the authorization) or `FORA_PRAZO_PERMITIDO` (outside the allowed window) —, `UNKNOWN_ERROR` when no reason was given, or the HTTP status of a request to the payment institution that failed (`400`, `500`). example: LIMITE_PERIODO_VALOR_EXCEDIDO description: type: string description: Description of the failure. example: Limite de valor do período excedido detail: type: string description: More detail on the failure, when there is any. example: O valor do pagamento excede o limite do período title: type: string description: Title of the failure, when there is one. example: Payment failed description: Why the charge failed, when it did. createdAt: type: string description: When the charge was created. example: '2026-11-05T14:20:31.655Z' format: date-time updatedAt: type: string description: When the charge last changed. example: '2026-12-03T03:30:12.904Z' format: date-time __v: type: number description: Internal revision counter of the record. example: 0 required: - _id - environment - realmId - organizationId - accountId - walletId - pixBillingAutomaticId - amount - status - scheduledTo - attempts - createdAt - updatedAt description: >- One charge of an authorization: the first payment or a recurring charge. description: The charges of this page, in the order you asked for. next: type: string nullable: true description: >- Cursor of the next page: send it as `next` to read it. `null` on the last page. example: NjcyOWYzZTFiNGQzZTgwMDEyYzlhN2Q0 required: - items - next description: A page of charges. '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; `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.