---
title: "Agendamento de recorrência"
method: POST
path: "/cards/invoices/recurrencies"
tags: ["Recorrência de cobrança"]
---

# Agendamento de recorrência

`POST /cards/invoices/recurrencies`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/cards/invoices/recurrencies`
- Auth: none declared. Required headers: `api-version`, `Authorization`

<div class="bkly-ref-description">
  <p>Realize o agendamento de uma cobrança recorrente de acordo com as necessidades de seu cliente.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: recurrency.write</span>
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Agendamento de recorrência](/docs/agendamento-de-recorrencia)."
}
[/block]

## Headers

- `api-version` string, required
- `Authorization` string, required: <i>Token</i> de autorização do tipo Bearer.
- `x-correlation-id` string: Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

## Request body

- ScheduleRecurrencyRequest
  - `hiringDate` string, date, required: Data da contratação do produto que deverá ser cobrado de forma recorrente.
  - `billingType` string, nullable, required: Tipo de cobrança. Preencha este campo com "" ou com null.
  - `recurrency` RecurrencyDto, required: Objeto que contém informações para o registro da Recorrência.
    - `postDate` integer, nullable: Dia em que deverá ser realizada a postagem de recorrência na fatura. Caso este campo não seja preenchido, será considerada a data informada em <code>hiringDate</code>.
    - `mustChargeOnHiringDate` boolean, required: Indica se a cobrança deverá ser realizada no mesmo dia da contratação, sendo TRUE para sim e FALSE para não. Caso este campo seja preenchido com TRUE, o valor informado no campo <code>postDate</code> será desconsiderado.
    - `frequency` 'ANNUALY' | 'MONTHLY' | 'WEEKLY', required: Frequência em que a recorrência deverá ocorrer.
    - `quantity` integer, required: Quantidade de cobranças da recorrência. Este campo deverá indicar quantas vezes a cobrança será realizada dentro da frequência informada.
    - `amount` AmountDto, required
      - `value` number, double, required: Valor da cobrança recorrente.
      - `currency` string, required: Código da moeda com base na ISO 3361.
    - `discount` AmountDto
      - `value` number, double, required: Valor da cobrança recorrente.
      - `currency` string, required: Código da moeda com base na ISO 3361.
    - `chargeOptions` ChargeOptions, required
      - `forceLimit` boolean, required: ndica se a cobrança recorrente deverá ocorrer para cartão sem limite.
      - `blockedAccount` boolean, required: Indica se a cobrança recorrente deverá ocorrer para contas bloqueadas.
  - `user` User, required
    - `documentNumber` DocumentNumber, required: Objeto que deverá conter informações sobre o documento do titular.
      - `value` string, required: Número do documento.
      - `type` 'CPF' | 'CNPJ', required: Tipo de documento.
    - `contract` Contract, required: Objeto que deverá conter informações sobre o contrato de crédito do titular do cartão.
      - `id` string, required: Identificador único do contrato, , o qual pode ser um número de proposta, contrato etc. relativo ao produto que o cliente do parceiro contratou.
      - `type` 'Credit' | 'Debit', required: Tipo de contrato.
  - `product` Product, required: Objeto que deverá conter informações sobre o produto que será cobrado de forma recorrente.
    - `id` string, required: Identificador único do contrato do produto.
    - `type` string, required: Tipo de produto que será cobrado.
    - `description` string, required: Descrição do produto. Essa mensagem será apresentada na postagem da cobrança.
    - `transactionType` 'SEGUROS_DEB' | 'SEGUROS_CRED', required: Código da transação.

## Response `201`

A solicitação foi aceita e o agendamento da recorrência de cobrança foi criado.

- BaseResult
  - `value` object
    - `code` string: Código personalizado da mensagem de sucesso.
    - `message` string: Descrição do código de sucesso.
    - `recurrencyId` string: Identificador único da recorrência agendada.
    - `productType` string: Descrição do produto enviado na requisição.

## Other responses

- `400`: Há algum problema com a sua requisição.
- `406`: A solicitação não foi aceita.

---

[API](https://skmtc.dev/bankly/apis/gest-o-de-cobran-a.md) - [All operations](https://skmtc.dev/bankly/apis/gest-o-de-cobran-a/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/gest-o-de-cobran-a/revisions/1a5c7aa17075?raw)