Captura

Capturar un pago confirma que está listo para la liquidación financiera. Esto transfiere los fondos autorizados desde la cuenta del tarjetahabiente hacia su cuenta de comerciante.

Reglas Clave

Si no se captura dentro de 7 días, la autorización es anulada (void) automáticamente por el sistema
El tiempo de liquidación comienza desde el momento de la captura, no de la autorización
Un pago solo puede capturarse una vez (pero puede capturar un monto parcial)
Si el pago se creó con "capture": true, ya fue capturado — intentarlo de nuevo devuelve un error
Si no se especifica un monto, se captura el monto autorizado completo

Endpoint

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

Headers:

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

Cuerpo de la Solicitud (Opcional)

Omita el cuerpo para capturar el monto autorizado completo. Inclúyalo para una captura parcial:

{
  "amount": {
    "total": 50.00,
    "currency": "USD"
  }
}

Campo	Tipo	Requerido	Descripción
`amount.total`	number	No	Monto a capturar (debe ser ≤ monto autorizado)
`amount.currency`	string	No	Código de moneda (debe coincidir con la autorización)

Ejemplo — Captura Total

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

Ejemplo — Captura Parcial

curl -X POST https://{FQDN}/payments/order-12345/capture \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": {
      "total": 50.00,
      "currency": "USD"
    }
  }'

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": "CAPTURED",
  "captured": true,
  "voided": false,
  "authCode": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "issuerName": "BANK OF AMERICA",
  "issuerCountry": "US",
  "cvcResult": "APPROVED",
  "avsResult": "NOT_SENT"
}

Para capturas parciales, el status será PARTIALLY_CAPTURED.

Qué Sigue

¿Capturado? → Ahora puede reembolsar el pago (total o parcial)
¿Cambió de opinión? → Solo los pagos no capturados pueden ser anulados (void)