---
title: "Listar recorrências"
method: GET
path: "/payments-recurrences"
---

# Listar recorrências

`GET /payments-recurrences`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/payments-recurrences`
- Auth: OAuth 2
  - Authorization code: `https://id.empresas.btgpactual.com/oauth2/authorize`
  - Token URL: `https://id.empresas.btgpactual.com/oauth2/token` scopes: `brn:btg:empresas:banking:payroll`

## Response `200`

successful operation

- object
  - `data` RecurrenceIdGetResponse[]
    - `id` string
    - `type` string
    - `status` string
    - `systemOrigin` string
    - `periodicity` object
      - `type` string
      - `detail` object
        - `startDate` string, date
        - `endDate` string, date
        - `quantity` integer
    - `basePayment` object
      - `type` string
      - `amount` number, float
      - `debitParty` object
        - `name` string
        - `taxId` string
        - `account` object
          - `type` string
          - `ispb` string
          - `branch` string
          - `number` string
          - `bankCode` string
      - `detail` object
        - `creditParty` object
          - `name` string
          - `taxId` string
          - `account` object
            - `bankCode` string
            - `ispb` string
            - `type` string
            - `branch` string
            - `number` string
        - `key` object
          - `value` string
          - `type` string
    - `errors` object[]
      - `detail` string
      - `code` string
      - `arguments` object
        - `contractId` string

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
