--- 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` ## Request - Base URL: `https://sandbox-cdn.pismolabs.io` - URL: `https://sandbox-cdn.pismolabs.io/inst-pull-pay/v1/pix/automatic/payment/order` - Auth: none declared. Required headers: `Authorization` 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` string - `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: Pismo 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](ref: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. - `type` 'SCHEDULE' | 'RETRY_OVERDUE' | 'RETRY_ERROR': Payment order type: * `SCHEDULE` - Standard scheduled payment order created from the recurrence cycle. * `RETRY_OVERDUE` - Retry generated when a payment order expired unpaid, or when the payer PSP did not respond or responded FAIL before the due date. A new payment order of the same type is created for retry, respecting the recurrence retry policy. * `RETRY_ERROR` - Intraday retry (only on the settlement date, until 21:00) created after a settlement failure that occurred after the payment order was already sent to SPI (BCB "Guia Pix Automático" §5.2, `finalidadeDoAgendamento = RIFL`). One payment order is created per retry requested by the payer PSP. - `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: Amount to be transferred. - `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: Payee-defined minimum payment amount for dynamic amount recurrences. - `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: 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: ISPB (Identifcador do Sistema de Pagamento Brazil) - 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:
`CACC` - Checking account
`SVGS` - Savings account
`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.
`SLRY` - Salary account. Employer deposits a fixed amount every month.
- `city_code` string: An IBGE 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. - unknown - `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: ISPB (Identifcador do Sistema de Pagamento Brazil) - 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:
`CACC` - Checking account
`SVGS` - Savings account
`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.
`SLRY` - Salary account. Employer deposits a fixed amount every month.
- `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 - `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)