Cancelar Boleto Emitido
Essa funcionalidade permite que os clientes da Onnix consigam cancelar boletos de cobranças realizadas para seus clientes.
Você pode realizar a busca de cobrança pelos seguintes dados:
- boletoId
curl -X DELETE https://api.onnixpay.com/api/v1/sdk/boleto/{{boletoId}}/cancel \
-H "X-API-Key: ox_your_key" \
-d '{
"reason": "Cancelamento do contrato com o cliente."
}'
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "OBE001",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
| Código | Mensagem |
|---|---|
| ODE001 | Não foi encontrado registro para o identificador informado. |
| ODE002 | Somente cobranças com status REGISTERED podem ser canceladas. |
| ODE003 | Máximo de 200 caracteres permitidos para o motivo de cancelamento da cobrança |