Cancelar uma Cobrança Avulsa
Essa funcionalidade permite que os clientes da Celcoin consigam cancelar boletos de cobranças realizadas para seus clientes.
Passos para Integrar
- Realizar autenticação na API - [API Reference]
- Cancelar Cobrança - [API Reference]
Você pode cancelar a cobrança pelos seguintes dados:
- TransactionId
cURL da chamada
curl --location --request DELETE 'https://sandbox.openfinance.celcoin.dev/baas/v2/charge/12312312312' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
"reason": "Cancelamento do contrato com o cliente."
}'
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"body": {
"transactionId": "ce9b8d9b-0617-42e1-b500-80bf9d8154cf",
"externalId": "externalId1",
"expirationAfterPayment": 5,
"amount": 12.5,
"duedate": "2023-12-30",
"debtor": {
"name": "Marcos Samuel Duarte",
"document": "49188474801",
"postalCode": "06463035",
"publicArea": "Rua Mãe D'Água",
"number": "1004",
"complement": "Apto 123",
"neighborhood": "Jardim Mutinga",
"city": "Barueri",
"state": "SP"
},
"receiver": {
"name": "Emilly Malu Tereza Sales",
"document": "23234457824",
"postalCode": "06474070",
"publicArea": "Alameda França",
"city": "Barueri",
"state": "SP",
"account": "30023646056263"
},
"pix": {
"transactionId": "817885753",
"transactionIdentification": "817885753",
"status": "Cancelado",
"key": "[email protected]",
"emv": "00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/pc/p/v2/cobv/303928a7b4034de09fddec6d1258c15d5204000053039865802BR5910Merle Yost6008Orinside61080863968162070503***6304D7D3"
},
"boleto": {
"transactionId": "32290",
"status": "Pago",
"bankEmissor": "santander",
"bankNumber": "4000178961",
"bankAgency": "1004",
"bankAccount": "0220060",
"barCode": "03392942700000009009022006000040001789610101",
"bankLine": "03399022070600004000317896101015294270000000900",
"bankAssignor": "CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA"
}
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE001",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
Codigo | Mensagem |
---|---|
CDE001 | Não foi encontrado registro para o identificador informado. |
CDE002 | Somente cobranças com status PENDING podem ser canceladas. |
CDE003 | Máximo de 200 caracteres permitidos para o motivo de cancelamento da cobrança |
Updated 3 months ago