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

# List recurrences

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

## Request

- Base URL: `https://sandbox-cdn.pismolabs.io`
- URL: `https://sandbox-cdn.pismolabs.io/inst-pull-pay/v1/pix/automatic`
- Auth: none declared. Required headers: `Authorization`

List Pix Automatic recurrences. By default, recurrences 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

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

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `items` Recurrence[]
    - `id` string: Pismo recurrence ID.
    - `role_type` 'PAYEE' | 'PAYER': Role type
    - `details` RecurrenceDetails
      - `recurrence_id` string: BACEN recurrence ID
      - `journey_type` 'AUT1' | 'AUT2' | 'AUT3' | 'AUT4': Recurrence payment type: `AUT1` - Bank notification. If the merchant has the payer's banking information, a push notification can be sent directly to the payer's bank app, prompting them to authorize the recurring payment. `AUT2` - Authorization via QR code. Payer scans a merchant provided QR code to authorize recurring payments. This method does not initiate an immediate payment, allowing the first payment to be scheduled for a later date. `AUT3` - Authorization via QR code with first payment. Similar to the second method, but the QR code includes information for both the authorization and the initial payment, enabling the payer to authorize the recurring payment and make the first payment in a single step. `AUT4` - Post-payment sign-up path. After completing a one-time payment via QR code, the payer is offered the option to authorize recurring payments for future transactions
      - `contract_id` string: Payee-created external ID for their reference.
      - `description` string: Recurrence payment description
      - `amount` number: Amount to be transferred.
      - `maximum_debit_allowed` number: Payer-defined maximum payment amount for dynamic amount recurrences.
      - `minimum_debit_allowed` number: Payee-defined minimum payment amount for dynamic amount recurrences.
      - `frequency_type` 'WEEK' | 'MONTH' | 'QUARTER' | 'SEMESTER' | 'YEAR': Recurrence payment type
      - `allow_attempts_after_expiration` boolean: Will charge continue after due date? If `true` the recurence will receive a `recurrence_id` starting with `RR`. Otherwise, it will start with `RN`.
      - `first_payment_date` string, datetime: First charge/payment date. Format = yyyy-mm-dd
      - `payee` Payee
        - `name` string, required: Name
        - `document_number` string, required: A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil). Must be numeric with 11-14 digits.
        - `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 account<br /> `SVGS` - Savings account<br /> `TRAN` - Transactional account (Brazil only). Also 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 /> `SLRY` - Salary account. Employer deposits a fixed amount every month.<br />
      - `payer` Payer
        - `document_number` string, required: A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil). Must be numeric with 11-14 digits.
        - `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 account<br /> `SVGS` - Savings account<br /> `TRAN` - Transactional account (Brazil only). Also 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 /> `SLRY` - Salary account. Employer deposits a fixed amount every month.<br />
        - `city_code` string: An <a href='https://www.ibge.gov.br/explica/codigos-dos-municipios.php' target="_blank">IBGE</a> municipal code is a 7-digit numerical ID that the Brazilian Institute of Geography and Statistics (IBGE) assigns to uniquely ID each municipality and federal district in Brazil.
      - `debtor` Debtor
        - `document_number` string, required: A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil). Must be numeric with 11-14 digits.
        - `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
    - `created_at` string, datetime: Created at datetime. RFC 3339 format
    - `updated_at` string: Scheduled item last updated time, RFC 3339 format
    - `status` 'CREATED' | 'ACCEPTED' | 'APPROVED' | 'REJECTED' | 'FINISHED' | 'EXPIRED' | 'CANCELLED': Recurrence status
    - `taxes` TaxesWithCategory: Now only available on ext env and just for direct participants. Tax information related to the transaction.
      - `tax_identifier` string: Tax identifier, referring to the NF-e, NFS-e or aggregating tax document. In Brazil, NF-e and NFS-e are the two primary types of mandatory electronic invoices (Notas Fiscais) used for tax compliance. * NF-e (Nota Fiscal Eletrônica): Used for the sale and movement of physical goods or products. It is regulated at the state level by SEFAZ (SEFAZ (Secretaria da Fazenda) is the State Department of Finance in Brazil.) and travels with the goods. * NFS-e (Nota Fiscal de Serviços Eletrônica): Used for the provision of services (e.g., consulting, repairs, digital subscriptions). It is regulated by individual city governments. The value entered must correspond to the tax document used for calculating the IBS and CBS taxes associated with the transaction.
      - `records` RecordsWithCategory[]: Tax records. It is **REQUIRED** to pass a minimum of 2 objects and a maximum of 4 objects, at least one with `CBS` tax type and at least one with `IBS` tax type.
        - `tax_type` 'CBS' | 'IBS': Tax type: * `IBS` = Goods and services tax. A state and municipal tax that unifies and replaces the main subnational consumption taxes (state ICMS and municipal ISS). * `CBS` = Contribution on goods and services. A federal tax that consolidates and replaces previous federal social contributions and taxes (PIS, Cofins, and IPI)
        - `tax_category` 'INF' | 'COR': Tax category: * `INF` (Conta e Ordem) = Tax information * `COR` (Informar no momento da emissão)) = Corrected tax
        - `amount` number: Tax amount. Must be greater than zero.
  - `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`: Unauthorized. Missing or invalid authentication token.
- `404`: Not found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/instant-payments-automatic-pix.md) - [All operations](https://skmtc.dev/pismo/apis/instant-payments-automatic-pix/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/instant-payments-automatic-pix/revisions/88d97a2eb4f6?raw)