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

# List payment orders

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

List payment orders. By default, payment orders 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

- `recurrenceId` string
- `roleType` 'PAYEE' | 'PAYER', required
- `perPage` integer
- `status` 'PENDING' | 'WAITING_CUSTOMER' | 'REGISTERED' | 'ACTIVE' | 'CANCELLED' | 'CANCELLING' | 'EXPIRED' | 'REJECTED' | 'CONCLUDED'
- `afterId` string
- `beginDate` string
- `endDate` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `items` PaymentOrderResponse[]
    - `account_id` integer — Account ID
    - `recurrence_id` string — BACEN recurrence ID
    - `end_to_end_id` string — This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information.
    - `status` 'PENDING' | 'WAITING_CUSTOMER' | 'REGISTERED' | 'ACTIVE' | 'CANCELLED' | 'CANCELLING' | 'EXPIRED' | 'REJECTED' | 'CONCLUDED' — Payment order status: * `PENDING` - Payment order exists in the database. * `WAITING_CUSTOMER`- Waiting on the payee to update the payment order amount. Refer to the [Update order](https://developers.pismo.io/pismo-docs/reference/update-order-automatic-pix) endpoint. * `REGISTERED` - Payment order was registered to SPI instant payment system. * `ACTIVE` - Payer PSP accepted payment order. * `REJECTED` - Payer PSP rejected payment order. Check `reason.code` and `reason.description`. * `CANCELLING` - Payment order was previously accepted, cancel process has begun. and it's waiting on counterparty acknowledgement. * `CANCELLED` - Payment order was previously accepted and then cancelled. Check `reason.code` and `reason.description`. * `EXPIRED` - Pix transaction was not found by the due date. Will trigger retry if applicable to the recurrence. * `CONCLUDED` - Pix transaction was found and payment order is concluded.
    - `transaction_identification` string — Transaction ID from a successful payment. **REQUIRED** for the `AUT3` journey.
    - `calendar` object
      - `due_date` string — Calendar due date
      - `working_day` boolean — Calendar working day?
    - `amount` number, double — Fee amount.
    - `dynamic_amount` boolean — Does recurrence have a dynamic amount? If `true`, `min_payment_amount` is **REQUIRED**. If `false`, `amount` is **REQUIRED**. Default is `false`.
    - `additional_information` string — Additional information
    - `max_payment_amount` number — Payer-defined maximum payment amount for dynamic amount recurrences.
    - `min_amount_allowed` number — Minimum payment amount for dynamic amount recurrences, defined by payee.
    - `reason` object
      - `code` 'ACCT' | 'BLCK' | 'CCLD' | 'FAIL' | 'OTHR' | 'SLBD' | 'SLCR' — Payment order cancellation reason: * `ACCT` - Paying or receiving user's transactional account closed * `BLCK` - Paying or receiving user's transactional account blocked * `CCLD` - Recurring payments authorization cancelled * `FAIL` - Settlement process failure or error * `OTHR` - Paying or receiving user requested cancellation for other reasons * `SLBD` - Paying user request * `SLCR` - Receiving user request
      - `description` string — Payment order cancellation reason desciption
    - `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
    - `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
    - `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
    - `taxes` TaxesWithCategory — Now only available on ext env and just for direct parciapants. Tax information related to the transaction.
      - `tax_identifier` string — Tax identifier, referring to the NFe, NFSe 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` — Access token is missing or invalid
- `404` — Not Found
- `500` — Internal server error

---

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