[DEPRECATED] Cancel Billing
PUT {{url_contbank}}/billings/cancel/:billing_id
[Esta rota não é mais válida (DEPRECATED)]
Endpoint para cancelamento de uma cobrança.
É possível realizar o cancelamento apenas de cobranças que estejam registradas e pendentes de pagamentos.
IMPORTANTE : Caso uma cobrança recorrente seja cancelada, as emissões das competências seguintes não serão geradas.
O billing_id deve ser enviado na URL. Trata-se do ID da cobrança a ser cancelada.
O X-Current-Identity deve ser preenchido no Header da requisição.
Request Schema
| Campo | Descrição |
|---|---|
| reason | Indica o motivo do cancelamento. Campo obrigatório. Verificar possíveis motivos no quadro abaixo. |
Response Schema
| Campo | Descrição |
|---|---|
| status | Pode ser PENDING(cobrança ainda sendo registrada), REGISTERED(cobrança já registrada e aguardando o pagamento), CANCELED(cobrança cancelada) ou SETTLED(cobrança paga/quitada). Ao realizar o cancelamento o status deverá ser retornado como CANCELED. |
| updated_at | Indica a data de atualização do status, ou seja, data do cancelamento da cobrança. |
| updated_by | Indica o ID do usuário que realizou a alteração na cobrança, ou seja, quem procedeu com o cancelamento. Nos casos dos parceiros, será vinculado ao ID do token de autenticação. |
Reason
Abaixo a lista de motivos aceitos para cancelamento de uma cobrança.
Este motivo é obrigatório para proceder com o cancelamento.
| Valor | Descrição |
|---|---|
| CANCEL-BILLING-REASON-001 | Baixado para acertos |
| CANCEL-BILLING-REASON-002 | Baixado para devolução |
| CANCEL-BILLING-REASON-003 | Baixado com pagamento direto ao cliente |
| CANCEL-BILLING-REASON-004 | Baixado para substituição |
| CANCEL-BILLING-REASON-005 | Baixado a pedido do cedente |
Request Body
{"reason"=>"Baixado com pagamento direto ao cliente"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Current-Identity | number | CPF/CNPJ do usuário que está cancelando a cobrança. |
RESPONSES
status: OK
{"_id":"6382dce123c71arrfa425a09","billing_method":"BOLETO","current_identity":"12345678901","account":{"account_id":"6109864a1555f85450005e6e","branch":"0001","number":"123456","identifier":"12345678901"},"payer":{"name":"NOME DO PAGADOR","trade_name":"TRADE NAME DO PAGADOR","identifier":"98798798789","address":{"street":"RUA DA CONSOLAÇÃO, 1000 APTO ABC","zip":"01301100","city":"SÃO PAULO","state":"SP"},"email":"teste@contbank.com","phone":{"country_code":"55","phone_number":"11999999999"},"notifications":{"send_email":true,"send_sms":true}},"due_date":"2023-02-01T00:00:00Z","close_payment":"2023-04-02T00:00:00Z","description":"EMISSÃO DE UMA COBRANÇA RECORRENTE","amount":20,"discounts":{"limit_date":"2023-01-31T23:59:59Z","value":15,"type":"FixedPercentUntilLimitDate"},"fine":{"start_date":"2023-02-02T00:00:00Z","value":2,"type":"Percent"},"interest":{"start_date":"2023-02-02T00:00:00Z","value":1.75,"type":"PercentPerMonth"},"status":"CANCELED","status_history":[{"status":"NEW","updated_at":"2022-11-27T03:43:33.467Z","updated_by":"6079c518aa81769229db2da7"},{"status":"PENDING","updated_at":"2022-11-27T03:43:48.732Z","updated_by":"6079c518aa81769229db2da7"},{"status":"REGISTERED","updated_at":"2022-11-27T03:44:09.263Z","updated_by":"6079c518aa81769229db2da7"}],"updated_at":"2022-11-27T03:45:08.433011878Z","updated_by":"6079c518aa81769229db2da7","created_at":"2022-11-27T03:43:33.467Z","created_by":"6079c518aa81769229db2da7","request_id":"5624bf84-7c2e-4a6e-8b88-13a992a83ea1","billing_method_related":{"updated_at":"2022-11-27T03:43:48.732Z","boleto_id":"6382dce5b1c9cd5b926e349e","authentication_code":"9d97a92e-b10f-44c9-850e-10dfd6882890"},"installment":1,"total_of_installments":4,"partner":{"fee_rate":2.75,"fee_value":5}}