Cancelamento (Void)

O cancelamento (void) anula um pagamento autorizado antes da captura. Os fundos reservados são liberados de volta à conta do portador do cartão.

Regras Principais

Só é possível se o pagamento ainda não tiver sido capturado
Cancelamentos (voids) são irreversíveis — o pagamento não pode ser recapturado após o void
Se o pagamento já foi capturado, use o Reembolso em vez disso
O externalPaymentId identifica o pagamento a ser cancelado

Endpoint

POST https://{FQDN}/payments/{externalPaymentId}/void

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`
`Content-Type`	`application/json`

Corpo da Requisição

Nenhum é necessário.

Exemplo

curl -X POST https://{FQDN}/payments/order-12345/void \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...' \
  -H 'Content-Type: application/json'

Resposta (200)

{
  "paymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "parentPaymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "externalPaymentId": "order-12345",
  "amount": 100.10,
  "created": "2024-04-22 16:22:06",
  "approved": true,
  "message": "Payment Approved",
  "automaticReversed": false,
  "status": "VOIDED",
  "captured": false,
  "voided": true,
  "authCode": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "issuerName": "BANK OF AMERICA",
  "issuerCountry": "US",
  "cvcResult": "APPROVED",
  "avsResult": "NOT_SENT"
}

Nota: A documentação original de void mostrava "status": "CAPTURED" na resposta — isso estava incorreto. Um pagamento cancelado (voided) tem "status": "VOIDED".