BAbankly
Recorrência de cobrança

Agendamento de recorrência

<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]
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

Headers

api-versionstring required

Versão da API. Atualmente estamos na 1.0.

Authorizationstring required

<i>Token</i> de autorização do tipo Bearer.

x-correlation-idstring

Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Request body

hiringDatestring date required

Data da contratação do produto que deverá ser cobrado de forma recorrente.

billingTypestring nullable required

Tipo de cobrança. Preencha este campo com "" ou com null.

Example request

{
  "hiringDate": "2024-04-01",
  "recurrency": {
    "amount": {
      "currency": "BRL"
    },
    "discount": {
      "currency": "BRL"
    }
  }
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.