Cancelamento de recorrência

Uma recorrência é automaticamente encerrada quando a quantidade de cobranças informada no agendamento é atingida.

No entanto, se o parceiro desejar encerrar uma cobrança recorrente a qualquer momento, basta utilizar o endpoint de cancelamento da recorrência.

📘
Importante
O cancelamento de uma recorrência é um ato irreversível e implica a interrupção de todas as futuras cobranças recorrentes associadas à transação.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

Possua uma cobrança recorrente ativa.

Requisição (Request)

Requisição HTTP

DELETE 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/recurrencies/{recurrencyId}'

--request DELETE \
--location --url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/recurrencies/{recurrencyId}'  
--header 'Authorization: Bearer {Token}' \
--header 'api-version: 1.0'\
--header 'x-correlation-id: {Guid}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`recurrency.delete`	Concede acesso para cancelar uma recorrência de cobrança.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.
`x-correlation-id`	Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

Nome	Tipo	Descrição	Especificação
`recurrencyId`	`path`	Obrigatório. Identificador único da recorrência que deverá ser atualizada. Informe o valor do campo `recurrencyId` retornado no endpoint Agendamento de recorrência.	—

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 201 indicará que a solicitação foi aceita e a recorrência da cobrança está sendo cancelada.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Número máximo de caracteres
`value`	`object`	Objeto que contém informações sobre a recorrência cancelada.	—
`value.code`	`string`	Código personalizado da mensagem de sucesso.	—
`value.message`	`string`	Descrição do código de sucesso.	—
`value.recurrencyId`	`string`	Identificador único da recorrência cancelada.	—
`value.productType`	`string`	Descrição do produto enviado na requisição.	—

{ 
  "value": { 
    "code": "RECURRENCY_DELETED", 
    "message": "Recurrency cancelled successfully.", 
    "recurrencyId": "COMPANY_KEY-edd874f6-6f00-4984-aa76-e50dabdba8a5", 
    "productType": "Seguros"
  } 
}

📘
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.