Cancela um pagamento de cartão, total ou parcialmente. Envie amount com o valor a cancelar (amount > 0): menor que o valor original = cancelamento parcial; igual = cancelamento total.
A elegibilidade do cancelamento (saldo remanescente, janela de prazo, bandeira e situação da transação) é validada pelo adquirente — pedidos inelegíveis retornam 422 com o código do motivo (ex.: AMOUNT_IS_HIGHER_THAN_THE_REMAINING_BALANCE, CANT_REFUND_TRANSACTION_FROM_TODAY, ORIGINAL_TRANSACTION_DATE_IS_TOO_OLD, CARD_BRAND_NOT_SUPPORTED, ORIGINAL_CYCLE_NOT_ACCEPTED).
O cancelamento é assíncrono: a resposta pode ser provisória. O campo status do pagamento pode ser:
VOIDED— cancelamento total aceito (síncrono, mesmo dia).PARTIALLY_VOIDED— cancelamento parcial aceito.REFUND_PENDING/PARTIAL_REFUND_PENDING— aceito para análise; o resultado definitivo chega depois pelo webhookacquiring.financial_cycle, correlacionado porrrn.PENDINGnunca é retornado como erro.
Sem resposta do adquirente
502 com code = ACQUIRER_COMMUNICATION_ERROR significa que a chamada ao adquirente não respondeu dentro do nosso tempo limite. Não é recusa e não significa que o pagamento falhou: a autorização original permanece intacta e a reserva continua no limite do portador.
Nesse caso, repita a mesma chamada. Esta rota não tem estado terminal: nós guardamos tudo o que o cancelamento precisa e reenviamos a operação, inclusive dias depois. Não é necessário abrir chamado nem criar um novo pagamento.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
400Validação local (INVALID_AMOUNT quando amount <= 0, INVALID_JSON).
403Token inválido ou IP não autorizado
404Pagamento não encontrado
422Cancelamento recusado por regra do adquirente (ex.: saldo insuficiente, fora da janela de prazo, bandeira não suportada).
502ACQUIRER_COMMUNICATION_ERROR — sem resposta do adquirente. A autorização continua de pé e a reserva segue no limite do portador; repita a mesma chamada.
