InStore Payment REST API

Accede al Swagger para realizar pruebas:

Introducción

Utiliza la API REST de InStore Payment para realizar pagos de forma fácil y segura desde una caja registradora/quiosco utilizando un terminal de pago externo en modo inalámbrico. Con esta API podrás realizar ventas y devoluciones.

Antes de integrar la solución de API REST de pago en tienda, necesitas una API Key para los entornos de prueba y en vivo. Contacta con Comercia para obtener tu API Key.

Instore Payment API funciona bajo dos arquitecturas:

InStore Payment Service instalado en Windows para poder utilizar los diferentes métodos que apuntan a localhost. La URL base a utilizar será «localhost:3000/». Se puede utilizar una conexión HTTP.
InStore Payment Service instalado en el dispositivo de pago para poder utilizar los diferentes métodos que apuntan a un dispositivo específico. En esta solución será necesario conocer la IP del dispositivo de pago, utilizando la URL base correspondiente (p.e.: «192.168.1.60:3000/»). Se debe utilizar una conexión HTTPS segura.

La solución InStore Payment API requiere:

Un dispositivo de pago.
Un dispositivo Windows si la solución utilizada incluye el servicio InStore Payment Windows.

Consulta estos diagramas de secuencia para saber cómo funciona una transacción de pago completa:

Con el fin de facilitar las tareas de integración, el servicio InStore Payment Api instalado en el terminal de pago permite simular una aplicación de pago ficticia para no depender de una aplicación de pago real y no necesitar tarjetas físicas para probar el flujo completo.

Esta aplicación ficticia es simplemente un conjunto de pantallas que muestra directamente la aplicación InStore Payment Api, por lo que no se requeriría ninguna aplicación adicional. Por tanto, aunque la aplicación de pago Comercia siempre se utilizará por defecto, también es posible utilizar la ficticia.

Todos los métodos son sincrónicos. No puedes iniciar una segunda transacción si la primera no se ha completado.

Llamar a los endpoints HTTPS con un certificado personalizado en Postman

Con el fin de explicar cómo se pueden realizar conexiones HTTPS seguras, se proponen las siguientes recomendaciones, utilizando el programa Postman como ejemplo de una caja ECR.

El problema:

Al lanzar una llamada a un endpoint HTTP, normalmente Postman comprueba que el certificado del servidor es válido y fue generado por una autoridad conocida. Cuando el servidor utiliza un certificado personalizado, no lo detecta como una autoridad conocida y, de forma predeterminada, la solicitud se bloquea mostrando el siguiente mensaje:

Error: Unable to get local issuer certificate

Solución:

Para iniciar la solicitud, puedes desactivar la comprobación de certificados. Después, Postman permitirá conexiones a cualquier HTTPS incluso si el certificado es desconocido o no válido.

Para desactivar la comprobación, haz clic en «settings», en la esquina superior derecha: