Anulación (Void)

La anulación cancela un pago autorizado antes de la captura. Los fondos reservados se liberan de vuelta a la cuenta del tarjetahabiente.

Reglas clave

Solo es posible si el pago aún no ha sido capturado
Las anulaciones son irreversibles — el pago no puede volver a capturarse después de anulado
Si el pago ya fue capturado, use Reembolso en su lugar
El externalPaymentId identifica el pago a anular

Endpoint

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

Encabezados:

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

Cuerpo de la solicitud

No se requiere.

Ejemplo

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

Respuesta (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: La documentación original de anulación mostraba "status": "CAPTURED" en la respuesta — esto era incorrecto. Un pago anulado tiene "status": "VOIDED".