5.3. Cancelar Contrato¶
🔗 Endpoint¶
| Método | URL |
|---|---|
/api/v1/cartao/contrato/{identificador} |
🧾 Descrição¶
Solicita o cancelamento de um contrato de cartão previamente criado. O processo de cancelamento é assíncrono e será processado junto à credenciadora.
⚠ Regras de Cancelamento¶
- Nenhuma UR vinculada ao contrato pode estar liquidada.
- A próxima UR performada (com data de liquidação mais próxima) deve estar ao menos 3 dias úteis à frente da data atual.
- Exemplo: Se hoje é 07/08, a próxima UR deve ser a partir de 12/08 (considerando 08, 09 e 12 como úteis).
Se essas regras forem atendidas, o pedido de cancelamento será encaminhado para a credenciadora.
🧪 Exemplo de cURL¶
curl -X DELETE https://api.veflow.com/api/v1/cartao/contrato/5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6 \
-H "Authorization: Bearer {seu_token}" \
-H "Content-Type: application/json"
📥 Responses¶
✅ 200 OK¶
{
"identificador": "5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6",
"mensagem": "Contrato enviado para cancelamento!"
}
❌ Possíveis Erros¶
🔸 400 Bad Request¶
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"titulo": "Atenção",
"status": 400,
"erros": [
"Não é possível cancelar o contrato pois já existem URs liquidadas."
]
}
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"titulo": "Atenção",
"status": 400,
"erros": [
"A próxima UR performada está com liquidação inferior a 3 dias úteis."
]
}
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"titulo": "Atenção",
"status": 400,
"erros": [
"Contrato não encontrado ou já cancelado anteriormente."
]
}
🔸 403 Fora da Janela de Operação¶
{
"mensagem": "Operação permitida apenas entre 09h e 18h em dias úteis."
}
🕒 Observações¶
- A operação é assíncrona: o status final do cancelamento será informado posteriormente.
- Cancelamentos fora das regras descritas serão rejeitados com erro HTTP
400 Bad Request.