---
title: "Consultar recorrência de pagamento"
method: GET
path: "/payments-recurrences/{recurrenceId}"
---

# Consultar recorrência de pagamento

`GET /payments-recurrences/{recurrenceId}`

## Path parameters

- `recurrenceId` string, required

## Response `200`

successful operation

- 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.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/revisions/2a24d3da114c/schema)