Este servicio permite realizar el cobro por el monto especificado a tarjetas de crédito y débito del comprador.

Parámetros de solicitud

A continuación, se describen los parámetros necesarios para realizar el cobro:

Parámetro	Tipo	Requerido	Descripción
customer	Object	False	Objeto que contiene la información del comprador. Si no se proporciona, la información del comprador será llenada usando los datos proporcionados en la tokenización de tarjeta.
order	Object	True	Objeto que contiene la información de la orden de compra.
cardId	String	True	Id de la tarjeta tokenizada del comprador.
authenticationId	String	Conditionally	Id de autenticación 3DS del procesador. Solo aplica a clientes que tengan 3DS configurado.
billingInfo	Object	True	Objeto que contiene la información de facturación del comprador.
locationCode	String	False	Identificador de la sucursal en la cuál se hace el cargo. Si no se proporciona, se usará la sucursal por defecto.

Parámetros de respuesta

A continuación, se describen los parámetros de respuesta al realizar un cobro:

Parámetro	Tipo	Descripción
status	String	Indica el estado del cobro.
message	String	Describe el resultado del parámetro status.
error	Object	Objeto que contiene el código y mensaje de error.
authentication	Object	Objeto que contiene la URL de autenticación y el id de validación para completar la transacción.
order	Object	Objeto que contiene la información de la orden de compra.
createdAt	DateTime	Fecha y hora de la transacción en UTC.

Estados de cobro (status)

Existen 3 posibles estados de cobro:

FAILED

Este estado representa que el proceso de pago ha fallado. El nodo error contendrá el código y mensaje de error.

SUCCEEDED

Este estado representa que el proceso de pago se ha realizado exitósamente.

AUTHENTICATION_REQUIRED

Este estado representa que la transacción requiere autenticación 3DS. Para validar la transacción, se debe redirigir al comprador a la URL proporcionada en el nodo authentication usando un iframe. A continuación se proporcionan ejemplos de implementación de iframe:

• Vanilla JS
• React JS

Expliación de la implementación

Para el manejo de este caso, el proyecto de frontend debe agregar un event listener que escuche el postMessage que se envía desde el iframe. La estructura del mensaje es la siguiente:

{
    "MessageType": string,
    "Status": string,
    "AuthenticationId": string,
    "OrderId": string,
    "OrderAmount": number
}

MessageType

• authentication.complete → autenticación completada exitósamente
• authentication.failed → error al procesar la autenticación

  Status

• PENDING → pendiente de autenticación
• SUCCESS → autenticación exitosa
• FAILED → no se logro autenticar con el banco emisor
• ERROR → error interno del procesador de pagos
• EXPIRED → la autenticación ha expirado

Una vez que se reciba el mensaje con MessageType = "authentication.complete" y Status = "SUCCESS", se debe realizar una nueva solicitud de cobro. En esta ocasión, se debe incluir el authenticationId recibido en el mensaje anterior para completar la transacción.

Recursos adicionales

• Postman Examples