---
title: "Criar recorrência de pagamento"
method: POST
path: "/payments-recurrences"
---

# Criar recorrência de pagamento

`POST /payments-recurrences`

## Request body

- RecurrenceRequest
  - `type` 'PAYMENT' | 'PIX_AUTOMATIC', required — Tipo do pagamento recorrente a ser criado
  - `periodicity` Periodicity, required
    - `type` 'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'ANNUALLY' | 'CUSTOM', required — Tipo de periodicidade da recorrência
    - `detail` union, required
      - object
        - `startDate` string, required — Data de início da recorrência
        - `quantity` integer, required — Quantidade de recorrências
      - object
        - `dates` string[], required — Datas específicas para a recorrência
  - `basePayment` RecurrenceBasePayment, required
    - `type` 'PIX_KEY' | 'PIX_MANUAL' | 'PIX_QR_CODE' | 'TEF', required — Tipo de pagamento a ser realizado recorrentemente
    - `amount` number, required — Valor do pagamento
    - `description` string — Descrição do pagamento
    - `internalDescription` string — Descrição interna do pagamento
    - `debitParty` Party, required
      - `taxId` string, required — CNPJ do pagador
      - `name` string, required — Nome do pagador
      - `account` object, required — Conta do pagador
        - `type` 'CC' | 'PP' | 'CS' | 'CD' | 'CI' | 'CG' | 'CP' | 'PG', required — Tipo de conta do pagador
        - `number` string, required — Número da conta do pagador
        - `branch` string, required — Agência da conta do pagador
        - `bankCode` string, required — Código do banco do pagador
        - `ispb` string — ISPB do banco do pagador
    - `detail` union, required — Detalhes do pagamento
      - object
        - `key` object, required — Chave pix do pagamento
          - `value` string, required
      - object
        - `emv` string, required — EMV do pix
      - object
        - `key` object, required — Chave pix do pagamento
          - `value` string, required
        - `transactionId` string, required — ID da transação do pagamento
      - object
        - `creditParty` Party, required
          - `taxId` string, required — CNPJ do pagador
          - `name` string, required — Nome do pagador
          - `account` object, required — Conta do pagador
            - `type` 'CC' | 'PP' | 'CS' | 'CD' | 'CI' | 'CG' | 'CP' | 'PG', required — Tipo de conta do pagador
            - `number` string, required — Número da conta do pagador
            - `branch` string, required — Agência da conta do pagador
            - `bankCode` string, required — Código do banco do pagador
            - `ispb` string — ISPB do banco do pagador
  - `recurringPaymentDates` string[]

## Response `200`

Successful

- object
  - `operationNeedsApproval` boolean
  - `contractGuid` string
  - `recurrenceId` 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)