---
title: "Atualização de recorrência"
method: PATCH
path: "/cards/invoices/recurrencies/{recurrencyId}"
tags: ["Recorrência de cobrança"]
---

# Atualização de recorrência

`PATCH /cards/invoices/recurrencies/{recurrencyId}`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/cards/invoices/recurrencies/{recurrencyId}`
- Auth: none declared

<div class="bkly-ref-description">
  <p>Atualize uma cobrança recorrente agendada previamente.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: recurrency.update</span>
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Atualização de recorrência](/docs/atualizacao-de-recorrencia)."
}
[/block]

## Path parameters

- `recurrencyId` string, required

## Parameters

- `#/paths/~1cards~1invoices~1recurrencies/post/parameters/0` (unresolved $ref)
- `#/paths/~1cards~1invoices~1recurrencies/post/parameters/1` (unresolved $ref)
- `#/paths/~1cards~1invoices~1recurrencies/post/parameters/2` (unresolved $ref)

## Request body

- ScheduleRecurrencyCommandUpdate
  - `billingType` string, nullable, required: Tipo de cobrança. Preencha este campo com "" ou com null.
  - `recurrency` RecurrencyUpdate, required
    - `postDate` integer, nullable: Dia em que deverá ser realizada a postagem de recorrência na fatura.
    - `amount` AmountDto
      - `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
      - `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.

## Response `200`

Success

- 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` (unresolved $ref)
- `406` (unresolved $ref)

---

[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)