Pagamentos
Cancelar Pagamento
Cancela uma transação de pagamento previamente criada
Cancelar pagamento
PUT /v1/payments/{paymentId}/cancelCancela uma transação de pagamento a partir do seu identificador.
Requer autenticação Bearer. Veja Autenticação.
Request
Parâmetros de rota
| Parâmetro | Tipo | Obrigatório | Exemplo |
|---|---|---|---|
paymentId | string | sim | 8f14e45f-ceea-467e-9a9f-1d1a3c1e5b3a |
Response
200 OK
{
"codigo": "0",
"mensagem": "Cancelamento efetuado com sucesso",
"status": "CAN",
"identificadorPagamento": "PAG-20250723-0001",
"numeroAutorizacao": "123456",
"valor": "15000",
"tipoPagamento": "C",
"esitefDate": "23/07/2026T14:41"
}Campos da resposta (principais)
| Campo | Tipo | Descrição |
|---|---|---|
codigo | string | Código de resposta. Diferente de 0 significa falha |
mensagem | string | Mensagem de resposta |
status | enum | Status do cancelamento — ver Status de transação |
identificadorPagamento | string | order_id do pagamento original |
valor | string | Valor cancelado em centavos (ex.: 15000 = R$ 150,00) |
esitefDate | string | Data de efetivação no formato DD/MM/AAAA'T'HH:mm |
Erros
| Status | Significado |
|---|---|
404 | Pagamento não encontrado para o paymentId informado |
409 | Pagamento não pode ser cancelado no estado atual |
500 | Erro interno ao cancelar o pagamento |