API Openpay
Consideraciones para el API Openpay
Siempre que se quiera utilizar el API Openpay se deberá contar con la llave privada la cual debe estar vigente y viajar en el Header de la solicitud, este valor sirve para realizar Basic Authentication y así poder consumir el API.
Las llaves se pueden consultar desde Dashboard al ingresar en la parte superior derecha dando clic en el icono de engranaje,entrando a la opción “Mi cuenta” misma en la que encontrarás la sección Llaves de acceso o bien en la opción Credenciales de acceso para el API.
Endpoints API Openpay
Endpoints disponibles para la generación de cargos con 3Ds desde la API para los diferentes ambientes para comercio y cliente:
Método: POST
Sandbox
https://sandbox-api.openpay.co/v1/{MERCHANT_ID}/charges
https://sandbox-api.openpay.co/v1/{MERCHANT_ID}/ customers/{CUSTOMER_ID}/charges
Producción
https://api.openpay.co/v1/{MERCHANT_ID}/charges
https://api.openpay.co/v1/{MERCHANT_ID}/ customers/{CUSTOMER_ID}/charges
Códigos de respuesta API
Crear transacción 3D Secure con Token
Para utilizar este servicio se debe tener un Token, el cual puede ser obtenido de las siguientes maneras:
Token de cargo previo. – Si previamente se realizó un intento de cobro a la tarjeta siguiendo la guía de Pagos con tarjeta y el resultado fue un código de error 3005 (Rechazo por riesgo), se puede usar el mismo token creado para 3D Secure.
Creación de nuevo Token. – Si no se cuenta con un token previo, se debe utilizar el servicio de creación de token para crear uno.
Una vez que tengas un token este deberá ser usado la propiedad source_id, descrito en la siguiente tabla que especifica los campos que se pueden enviar en la petición del API:
Ejemplo de petición:
Header: Basic {llave privada vigente}
{
“method”: “card”,
“amount”: 832,
“currency”: “COP”,
“description”: “Prueba con 3DS”,
“order_id”: “orden123456789”,
“redirect_url”: “https://www.openpay.mx/index.html”,
“device_session_id”: “device12234567s8”,
“use_3d_secure”: “true”,
“confirm”:“true”,
“source_id”: “k81aoifelkna2efguzle”,
“customer”: {
“name”: “Alonso”,
“last_name”: “Test”,
“phone_number”: “8884444444”,
“email”: “test2@openpay.mx”
}
Envío de URL de autenticación
La respuesta a la petición de creación de cargo será un JSON con la información de la transacción a pagar por el usuario. Se debe poner especial atención en los siguientes parámetros:
id – ID único de la transacción creada, debe ser almacenado ya que será por medio de este ID que se envíe la respuesta una vez que el usuario realice la autenticación 3D Secure.
payment_method.url – URL a donde se debe redirigir al usuario para iniciar el proceso.
Ejemplo de la respuesta:
{
“id”: “trjd5i68lurpekpg15hb”,
“authorization”: “000000”,
“operation_type”: “in”,
“transaction_type”: “charge”,
“status”: “charge_pending”,
“conciliated”: true,
“iva”: “0”,
“creation_date”: “2024-04-01T17:50:32-06:00”,
“operation_date”: “2024-04-01T17:50:32-06:00”,
“description”: “Prueba con 3DS”,
“error_message”: null,
“order_id”: “orden123456789”,
“card”: {
“type”: “credit”,
“brand”: “visa”,
“address”: {
“line1”: “Av 5 de Febrero”,
“line2”: “Roble 207”,
“line3”: “Col Carrillo”,
“state”: “Colombia”,
“city”: “Colombia”,
“postal_code”: “76900”,
“country_code”: “CO”
},
“card_number”: “400558XXXXXX1886”,
“holder_name”: “Hectorito Alonso Test”,
“expiration_year”: “27”,
“expiration_month”: “01”,
“allows_charges”: true,
“allows_payouts”: false,
“bank_name”: “BANXICO”,
“bank_code”: “001”
},
“gateway_card_present”: “CREDIBANCO”,
“payment_method”: {
“type”: “redirect”,
“url”: “https://dev-api.openpay.co/v1/m1c3xff4vje0ratdi93g/charges/trjd5i68lurpekpg15hb/redirect/”
},
“amount”: 832.00,
“currency”: “COP”,
“customer”: {
“name”: “Alonso”,
“last_name”: “Test”,
“email”: “test2@openpay.mx”,
“phone_number”: “8884444444”,
“address”: null,
“creation_date”: “2024-04-01T17:50:31-06:00”,
“external_id”: null,
“clabe”: null
},
“method”: “card”
}
La URL contenida en la propiedad payment_method.url inicia el proceso, cuando el servicio de autenticación no logra autenticar al cliente se realiza el flujo Challenge y le solicita ingresar un código en la siguiente pantalla.
Cuando el cliente es autenticado exitosamente se realiza el flujo Frictionless, es decir que este paso no se realiza.
Redireccionamiento a URL de respuesta
Una vez completa la autenticación del usuario en el sistema 3D Secure y recibida la respuesta en Openpay, se re-direccionará al usuario a la URL definida en el paso 2 (redirect_url) usando el ID de la transacción que se envió en el paso 5. Ejemplo: http://www.openpay.co/index.html?id=treqwygvw0hrjuvwbsf5
Notas:
Puedes simular diferentes resultados usando las tarjetas de Pruebas
Implementa las Notificaciones para conocer el estado de los pagos en tiempo real
