Introducción
En nuestras API encontrarán la documentación necesaria para ayudarlos a conectarse a nuestros servicios de validaciones de pago móvil (P2C) o generar pagos bajo la modalidad de C2P y generar Vueltos Digital.
El servicio P2C consiste en hacer pagos móviles desde personas a comercios, y nuestro API les permite validar en línea dicho pago, a partir de ciertos datos, sin necesidad de entrar al banco.
El servicio de C2P, permite generar pagos desde nuestro API, haciendo el débito directo al cliente, previamente autorizado por un OTP que el cliente natural solicita al banco y le comunica al cajero o a la página del comercio.
El servicio de Vuelto Digital, permite ofrecerle a tus clientes un método efectivo, seguro e inmediato para recibir el vuelto de sus compras.
El API de ekiibotón les brinda integraciones con diferentes plataformas de distintos bancos para los servicios (P2C, C2P y Vuelto digital), como lo son Banco Plaza, Bancrecer, Banco Activo y Bancaribe.
Para hacer más fácil la comprensión de nuestra API, preparamos un conjunto de ejemplos de código que les ayudará a la integración que necesiten implementar. La información que les proporcionamos es en nuestro entorno Sandbox, lo que les permitirá experimentar con la API sin hacer pagos reales, luego de recibir acceso a dicho ambiente.
AUTENTICACIÓN /auth (P2C/C2P/Vuelto Digital)
Cada comercio debe contar con un username y una contraseña proporcionados por ekiipago. En caso de que el comercio ya tenga una integración de un botón y vaya a incluir un segundo botón, debe enviar el id de la plataforma aparte de los dos datos anteriores. El id de la plataforma, de igual manera que los datos anteriores, es proporcionado por ekiipago. Al invocar este endpoint, con los datos necesarios según sea el caso, se devuelve un token de acceso que se debe de usar para el resto de los endpoint que están protegidos. Se utilizaría el encabezado HTTP “Autorización” en el formato Authorization: Bearer <token>.
Request body
{
"username": "string",
"platformId": 0,
"password": "string"
}
/payment/createOrder (P2C/C2P/Vuelto Digital)
Este endpoint permitirá crear órdenes en el sistema de ekiipago con estatus PENDIENTE, que luego serán actualizadas de acuerdo con su resultado posteriormente. El token generado en /auth se debe colocar en este endpoint para poder consumirlo.
Request body
{
"reference": "string",
"currency": "VES",
"amount": 0,
"customer_name": "string",
"customer_email": "string",
"customer_phone": "04141112233",
"customer_identification": "V11222333",
"customer_bank": "0138"
}
/payment/searchTransaction (P2C)
Este endpoint permitirá validar el pago móvil en línea que realice el cliente natural y que previamente fue creado con el endpoint createOrder. Con este endpoint consultamos en el banco si el pago cayó en la cuenta, y de ser así, se responde como exitoso. El token generado en /auth se debe colocar en este endpoint para poder consumirlo.
/payment/processPayment (C2P)
Este endpoint permitirá generar un pago, previamente autorizado por el cliente por medio de una OTP, donde se le debita al cliente natural y se abona a la cuenta del comercio.
Request body
{
"token": "string",
"description": "string",
"cashRegister": "string",
"channel": "string",
"ipAddress": "string",
"branchOffice": "string",
"terminalType": "string",
"seller": "string"
}
/payment/reversePayment (C2P)
Este endpoint permitirá generar el reverso de un pago que se haya procesado exitosamente, el reverso se debe hacer el mismo día para que se ejecute de forma exitosa.
/payment/processDigitalChange (Vuelto Digital)
Este endpoint permitirá generar el vuelto digital que se requiera. Se necesitará el parámetro reference que se generará del createOrder más el siguiente request:
Request body
{
"channel": "string",
"description": "string",
"cashRegister": "string",
"ipAddress": "string",
"branchOffice": "string",
"terminalType": "string",
"seller": "string"
}