Saltar al contenido principal
POST
No ejecutes una captura mientras otra está en curso. Espera a que la operación actual termine antes de iniciar una nueva.
Esta solicitud captura un pago que fue autorizado previamente. Esta acción es necesaria para finalizar un pago cuando una autorización se creó con la opción de captura en false. Según el proveedor de pago, la captura puede ser parcial (incluidas varias capturas) o total. El amount es opcional: si lo omites, la API captura el monto autorizado completo. Una captura mayor que la autorización se envía al proveedor, que decide si la acepta.
Pagos con una promoción de YunoEl monto autorizado es lo que paga el cliente, amount.value menos discount_amount, por lo que una captura completa toma ese monto y payment.amount.captured lo refleja. Consulta Promotions.
Pagos aprobados parcialmentePara un pago enviado con payment_method.detail.card.partial_approval: true y aprobado por menos de lo solicitado, el monto autorizado es payment.amount.authorized. Una captura sin amount captura amount.authorized, y capturarlo todo completa la captura. Una captura por encima de amount.authorized se rechaza con 400 INVALID_PARAMETERS y el mensaje “Amount to capture exceeds the authorized amount.” Para cualquier otro pago, la captura funciona como se describe arriba.
Si la autorización se aumentó con autorizaciones incrementales, un amount explícito puede liquidar hasta el total aumentado, y una captura sin amount liquida la retención actual completa de la transacción: el monto autorizado original más todos los incrementos exitosos de esa transacción. Ten en cuenta que esta solicitud requiere un X-Idempotency-Key. Consulta la página Authentication para obtener más información.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido
X-Idempotency-Key
string
header
predeterminado:<Your X-Idempotency-Key>
requerido

Parámetros de ruta

payment_id
string
requerido

El identificador único del pago (UUID, 36 caracteres).

transaction_id
string
requerido

El identificador único de la transacción (UUID, 36 caracteres)

Cuerpo

application/json
merchant_reference
string
requerido

Identificación de la transacción de pago definida por el comercio (MAX 255; MIN 3)

reason
string
requerido

Indica el motivo de la captura. Por ejemplo: PRODUCT_CONFIRMED y REQUESTED_BY_CUSTOMER.

amount
object

Especifica el objeto de monto para la captura. Opcional: si lo omites, la API captura el monto autorizado completo.

additional_data
object

Datos adicionales para complementar la captura del pago

simplified_mode
boolean

Determina si Yuno debe intentar capturar automáticamente un pago después de un error o rechazo inicial. Cuando se establece en true, Yuno reintenta el proceso si el primer intento falla. Por defecto, es false. Accede a Reintentos de transacciones para más detalles.

Respuesta

201

id
string
Ejemplo:

"89fd7fd0-951d-4335-ad1b-ef899a79630d"

type
string
Ejemplo:

"CAPTURE"

status
string
Ejemplo:

"SUCCEEDED"

category
string
Ejemplo:

"CARD"

amount
object
merchant_reference
string
Ejemplo:

"AAB01-432245"

created_at
string
Ejemplo:

"2024-06-06T14:26:41.535489Z"

updated_at
string
Ejemplo:

"2024-06-06T14:26:41.615608Z"

provider_data
object
connection_data
object
response_code
string
Ejemplo:

"SUCCEEDED"

response_message
string
Ejemplo:

"Transaction successful"

payment
object