---
title: "List recurrence authorizations"
method: GET
path: "/inst-pull-pay/v1/pix/automatic/authorizations"
tags: ["Automatic Pix data"]
---

# List recurrence authorizations

`GET /inst-pull-pay/v1/pix/automatic/authorizations`

List Pix Automatic recurrence authorizations. By default, recurrences authorizations from the last 30 days with 20 records per page are returned, but you can use the `beginDate` and `endDate` query parameters to specify a different date range.

## Query parameters

- `status` 'CREATED' | 'PENDING' | 'EXPIRED' | 'ACCEPTED' | 'REJECTED' | 'IN_PROGRESS' | 'FINISHED' | 'CANCELLED' | 'RECEIVED' | 'CONFIRMED' | 'WAITING_CUSTOMER'
- `roleType` 'PAYEE' | 'PAYER', required
- `perPage` integer
- `afterId` string
- `beginDate` string
- `endDate` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `items` Authorization[]
    - `id` integer — Authorization ID of the debit transaction for `installment_amount`.
    - `role_type` 'SECONDARY_DEBIT' | 'SECONDARY_CREDIT' | 'SECONDARY_LOC' | 'SECONDARY_INSTALLMENT' | 'SECONDARY_PREPAID' — Card role type: * `SECONDARY_DEBIT`—Debit card * `SECONDARY_CREDIT`—Credit card * `SECONDARY_LOC`—Secondary/fallback funding source * `SECONDARY_INSTALLMENT`—Installment plan * `SECONDARY_PREPAID`—Prepaid card
    - `created_at` string, date-time — Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.
    - `updated_at` string, date-time — Datetime program calendar strategy was updated. Format = YYYY-MM-DDTHH:MM:SS:MM
    - `account_id` integer — Account ID
    - `recurrence_id` string — BACEN recurrence ID
    - `expiration_date` string — Card expiration date (format = yymm). If passed, the card expiration date is not calculated using the "Card expiration (# of months)" program parameter.
    - `provider_created_at` string, date-time — Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.
    - `provider_updated_at` string, date-time — Datetime program calendar strategy was updated. Format = YYYY-MM-DDTHH:MM:SS:MM
    - `max_payment_amount` union
      - number — Payer-defined maximum payment amount for dynamic amount recurrences.
      - unknown
    - `reason_code` 'AC01' | 'AC04' | 'AC06' | 'AP01' | 'AP02' | 'AP03' | 'AP04' | 'AP05' | 'AP06' | 'AP07' | 'AP08' | 'AP09' | 'AP10' | 'AP11' | 'AP12' | 'AP13' | 'AP14' | 'AP15' | 'CH16' | 'MD01' | 'MD20' — Authorization reason code. **Note:** "pain.009" is a message sent to the payer when the payee starts a #1 journey (`AUT1`) Automatic Pix recurrence * `AC01` - Account not found or not belonging to the paying user * `AC04` - Paying user's transactional account is closed * `AC06` - Paying user's transactional account is blocked * `AP01` - Discrepancy in the field for updating periodic payments recurrence data and the periodic payments recurrence status - lack of synchronization * `AP02` - Paying user's CPF/CNPJ not found or different from the one in the original pain.009. Or, in the case of cancellation, the paying user's CPF/CNPJ does not match the one contained in the perioduc payments recurrence data. * `AP03` - Paying user's branch not found * `AP04` - Invalid recurrence ID or does not match the original * `AP05` - Inconsistent recurrence status for periodic payments * `AP06` - Receiving user's CPF/CNPJ is different from the one in the pain.009 or the payload. Or, in the case of cancellation, the receiving user's CPF/CNPJ does not match the one contained in the periodic payments recurrence data. * `AP07` - Paying user's recurrence confirmation performed after the confirmation request's expiration or cancellation (pain.009) * `AP08` - First immediate payment associated with the recurrence was not identified. (Valid only for Authorization Journey 3 (`AUT3`)) * `AP09` - Recurrence confirmation request for periodic payments was not identified to enable its cancellation * `AP10` - Cancellation requestor's CPF/CNPJ does not match the the paying/receiving user's or the paying/receiving PSP's identification contained in the periodic payments recurrence data. * `AP11` - Paying PSP's ISPB diverges from the information contained in the recurrence for periodic payments * `AP12` - Receiving PSP's ISPB diverges from the information contained in the recurrence for periodic payments * `AP13` = Paying user rejects periodic payments recurrence confirmation request due to receiving user non-recognition * `AP14` - Paying user rejects periodic payments recurrence confirmation request due to receiving user's lack of interest in using Pix Automatic * `AP15` - Paying user's participant rejects recurrence confirmation request for periodic payments as they chose not to offer Pix Automatic usage for corporate clients * `CH16` - Incorrect or incompatible message content with business rules * `MD01` - Cancellation request's recurrence object does not exist. Should not be used for cancellation requests of pain.009 with status = `PDNG`. That is, a recurrence with status = `PDNG` should be considered as an existing recurrence. * `MD20` - Cancellation request's recurrence object has already expired.
    - `payer` union
      - Payer
        - `document_number` string, required — Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.
        - `document_type` 'LEGAL_PERSON' | 'NATURAL_PERSON', required — Person type: * `LEGAL_PERSON` - An actual person with legal rights. * `NATURAL_PERSON` - An entity, such as an organization or company.
        - `name` string, required — name
        - `bank` string, required — <a href="https://bank.codes/numero-do-banco/bank/banco-central-do-brasil/" target="_blank">ISPB (Identifcador do Sistema de Pagamento Brazil)</a> - the Brazilian Payment System ID for the receiving bank, an 8-digit value.
        - `branch` string, required — This could be a bank-assigned branch ID or the branch's ISPB number.
        - `account_number` string, required — Payer's account number.
        - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN' — Account type: <br /> `CACC` - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking.<br /> `SVGS` - Savings account<br /> `TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments.<br /> `SLRY` - Salary account. Employer deposits a fixed amount every month.<br />
        - `city_code` string — The <a href='https://www.ibge.gov.br/explica/codigos-dos-municipios.php' target="_blank">IBGE</a> (Instituto Brasileiro de Geografia e Estatística) city code.
      - unknown
    - `rec_payload` union
      - RecPayload
        - `recurrence_id` string — BACEN recurrence ID
        - `contract_id` string — Payee-created external ID for their reference.
        - `description` string — Recurrence payment description
        - `amount` number, double — Fee amount.
        - `min_payment_amount` number — Minimum payment amount for dynamic amount recurrences, defined by payee.
        - `frequency_type` 'WEEK' | 'MONTH' | 'QUARTER' | 'SEMESTER' | 'YEAR' — Recurrence payment type
        - `allow_attempts_after_expiration` boolean — Will charge continue after due date?
        - `first_payment_date` string, datetime — First charge/payment date. Format = yyyy-mm-dd
        - `payee` Payee
          - `name` string, required — name
          - `document_number` string, required — Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.
          - `document_type` 'LEGAL_PERSON' | 'NATURAL_PERSON', required — Person type: * `LEGAL_PERSON` - An actual person with legal rights. * `NATURAL_PERSON` - An entity, such as an organization or company.
          - `bank` string, required — <a href="https://bank.codes/numero-do-banco/bank/banco-central-do-brasil/" target="_blank">ISPB (Identifcador do Sistema de Pagamento Brazil)</a> - the Brazilian Payment System ID for the receiving bank, an 8-digit value.
          - `branch` string, required — This could be a bank-assigned branch ID or the branch's ISPB number.
          - `account_number` string, required — Payer's account number.
          - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN', required — Account type: <br /> `CACC` - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking.<br /> `SVGS` - Savings account<br /> `TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments.<br /> `SLRY` - Salary account. Employer deposits a fixed amount every month.<br />
        - `debtor` Debtor
          - `document_number` string, required — Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.
          - `document_type` 'LEGAL_PERSON' | 'NATURAL_PERSON', required — Person type: * `LEGAL_PERSON` - An actual person with legal rights. * `NATURAL_PERSON` - An entity, such as an organization or company.
          - `name` string, required — name
      - unknown
  - `page_size` number — Maximum elements returned per query.
  - `number_elements` number — Total items returned in query
  - `next_page` boolean — Are tbere more results?
  - `last_id` integer — Last returned item ID. Use this ID to get more results.
  - `filters` QueryFilters[]
    - `label` string — Filter label
    - `value` string — Filter value
    - `operator` string — Filter operator

## Other responses

- `400` — Bad request
- `401` — Access token is missing or invalid
- `404` — Not Found
- `500` — Internal server error

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)