Cancelar Boleto
POST /boletos/:id/cancelar
Solicita a baixa do boleto junto ao banco.
Autenticação
x-api-key: {apiKey}
Parâmetros de URL
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID (UUID) do boleto |
Exemplo
curl -X POST https://api.engineapi.com.br/boletos/uuid-do-boleto/cancelar \
-H "x-api-key: SUA_API_KEY"
Resposta (200)
{
"success": true,
"message": "Boleto 000001234 cancelado",
"data": {
"id": "uuid-do-boleto",
"nossoNumero": "000001234",
"status": "CANCELED"
}
}
Regras
- Apenas boletos com status
PENDINGouREGISTEREDpodem ser cancelados - Boletos
PAIDnão podem ser cancelados