Void payment (total ou parcial)

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 webhook acquiring.financial_cycle, correlacionado por rrn. PENDING nunca é 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
required

Token transacional da operação original.

string
required

CPF ou CNPJ do estabelecimento (merchant).

number
required

Valor a cancelar (> 0). Menor que o original = parcial; igual = total.

string

Moeda (ex.: BRL).

Responses

400

Validação local (INVALID_AMOUNT quando amount <= 0, INVALID_JSON).

403

Token inválido ou IP não autorizado

404

Pagamento não encontrado

422

Cancelamento recusado por regra do adquirente (ex.: saldo insuficiente, fora da janela de prazo, bandeira não suportada).

502

ACQUIRER_COMMUNICATION_ERROR — sem resposta do adquirente. A autorização continua de pé e a reserva segue no limite do portador; repita a mesma chamada.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json