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.

Elegibilidade (avaliada pelo adquirente)

Saldo remanescente, janela de prazo, bandeira e situação da transação são validados pela Dock. Pedidos inelegíveis retornam 422 com o code do motivo — exemplos:

  • 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
  • ACQUIRER_REJECTED (fallback quando a Dock não devolve code)

Corpo NÃO aceita cartão

O cartão original já está vinculado ao snapshot. Enviar card ou tokenData retorna 400 INVALID_JSON.

Status possíveis (assíncrono)

A resposta pode ser provisória — o status do pagamento pode ser:

  • VOIDED — cancelamento total aceito (síncrono, mesmo dia).
  • PARTIALLY_VOIDED — cancelamento parcial aceito.
  • REFUND_PENDING — total aguardando settlement (resultado final via webhook acquiring.financial_cycle, correlacionado por rrn).
  • PARTIAL_REFUND_PENDING — parcial aguardando settlement.

PENDING não é erro. Rejeições vêm com errors[] e status HTTP da Dock.

Autenticação

  • Bearer JWT (Autra) no header Authorization (APIGW).
  • Transactional Token (transactionalToken) no body — obrigatório, encaminhado no header Authorization pra Dock.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID Autra do snapshot original a cancelar.

Body Params
string
required

Token transacional (Bearer eyJ...) da rota de initialize.

string
required

CNPJ (14) ou CPF (11) do merchant. Sem máscara.

double
required
≥ 0.01

Valor a cancelar. < snapshot.amount = parcial; = snapshot.amount = total.

Responses

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