Cancelar uma cobrança

No caso de uma cobrança ter sido criada, e ainda estar pendente de pagamento, é possível realizar o cancelamento.

Para isso, será necessário utilziar o endpoint DELETE Cancelar Cobrança.

Após ser cancelada, o status da cobrança será alterado para CANCELED.

As cobranças canceladas continuam sendo listadas na API de listagem. Da mesma forma, é possível obter os detalhes da cobrança, como valor, descrição, e métodos e condições de pagamento que foram definidos no momento da sua criação.

Caso um cliente tente acessar o link de pagamentos gerado para a cobrança, e ela já tiver sido cancelada, visualizará em tela que essa cobrança não está mais disponível, pois foi cancelada pelo responsável pela sua geração. Nessa tela, os padrões de cores são mantidos como designados no momento da criação da cobrança.

🚧

Atenção

Uma vez que a cobrança tiver sido cancelada, não será mais possível reativá-la. Caso necessário, deve ser criada uma nova cobrança com as mesmas características da anterior.


Modelo de Requisição:

Request

curl --location --request DELETE 'https://sandbox.openfinance.celcoin.dev//baas/v1/payment-links/orders/{orderId}' \
--header 'Authorization: Bearer *****’

Query Params

CampoDescriçãoTipoObrigatório
accountNúmero da conta no BaaS.stringNão
customizationIdid da customização.BooleanSim
orderIdID da cobrança.stringSim