¿Cómo te integras a nuestras soluciones?
Este es el proceso que debes hacer para que la integración con Nequi quede al pelo:
Selecciona tu producto de interés de Negocios Nequi aquí
Continúa con tu registro o déjanos tus datos para contactarte.
Comienza la integración con la documentación del paso anterior
Una vez tengas lista la documentación envía en un solo correo a: certificacion@conecta.nequi.com lo siguiente:
Casos de prueba de la API que escogiste en formato JSON, se debe completar la certificación de todos los servicios asociados al modelo de integración con el que se planea vincular. Abajo encontrarás los casos de prueba correspondiente a cada solución.
Un video, gif o imágenes de cómo será la experiencia del usuario Nequi en tu negocio.Te recomendamos tener en cuenta: lineamientos básicos de UX.
Ten en cuenta que:
En el paso 3 nos debes enviar la información que confirme que tus desarrollos quedaron bien, según la API que escogiste:
Espera hasta 4 días hábiles para recibir el correo de aprobación de tus certificaciones
Recibirás las llaves de producción al correo que registraste en Nequi Negocios.
Tras recibir las llaves de producción, actualiza los endpoints, enlaces de los servicios y credenciales para el ambiente de producción.
Aquí encuentras la información según la API que elegiste.
Durante 15 días en Slack cuentas con soporte técnico para tu integración con Nequi.
Pasados los 15 días puedes solicitar soporte técnico Aquí
Nuestras soluciones*
APIs de Pagos
API de pagos con push:
1
Request y response del servicio de envío de notificación de pago de la API pagos con push y pantallazo del comprobante de pago desde la App, en el ambiente de pruebas y con un número de celular que esté activo.
Además, el request y response del servicio de consulta de estado de pago, que demuestre que funcionó sin problema.
2
Request y response del servicio de envío de notificación de pago de la API pagos con push en el ambiente de pruebas y con un número de celular que esté activo, pero el pago debe haberse rechazado desde la app.
3
Request y response del servicio de envío de notificación de pago de la API pagos con push en el ambiente de pruebas y con un número de celular que esté activo, pero el pago debe vencerse o expirar al esperar 45 minutos.
4
Request y response del servicio de envío de notificación de pago de la API pagos con push en el ambiente de pruebas, con un número de celular que esté activo y con un número de celular que no tenga Nequi.
5
Request y response del servicio de reverso de un pago con la API push que haya funcionado sin problema.
El servicio de reverso es obligatorio. Debe usarse si: se desea cancelar el pago pendiente antes de que un usuario haga el pago, si hay fallas técnicas en tu sistema con la confirmación de pago o cuando el servicio de Nequi muestra timeout o error 500 y no se puede confirmar si el usuario Nequi realizó o rechazó el pago.
Por eso, es súper importante tener la capacidad de usar este servicio.
API de pagos con QR dinámico:
1
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción y pantallazo que compruebe la aceptación desde la App, en el ambiente de pruebas y con un número de celular que esté activo.
Además, el request y response del servicio de consulta de estado de suscripción, que demuestre que fue aceptada.
2
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción y pantallazo que compruebe el rechazo desde la App en el ambiente de pruebas y con un número de celular que esté activo.
Además, el request y response del servicio de consulta de estado de suscripción, que demuestre que fue rechazada.
3
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción en el ambiente de pruebas y con un número de celular que esté activo, pero la suscripción debe vencerse o expirar al esperar 15 minutos.
Además, el request y response del servicio de consulta de estado de suscripción, que demuestre que expiró o no existe.
4
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción, con un número de celular que no exista en ambiente de pruebas.
5
Request y response del servicio de pago automático con la API de pagos de suscripción y pantallazo del comprobante del débito desde la app, en el ambiente de pruebas y con un número de celular que esté activo.
6
Request y response del servicio de pago automático con la API de pagos de suscripción, con un monto mayor al saldo que tiene un número de cel que esté activo y exista en el ambiente de pruebas.
7
Request y response del servicio de pago automático con la API de pagos de suscripción, con una suscripción que no fue aceptada por un número de celular que esté activo y exista en el ambiente de pruebas.
8
Request y response del servicio de pago automático con la API de pagos de suscripción, con una suscripción que fue rechazada por un número de celular que esté activo y exista en el ambiente de pruebas.
9
Request y response del servicio de devolución o reverso de un pago con la API de pagos de suscripción que haya funcionado sin problema.
El servicio de reverso es obligatorio. Debe usarse si: se desea cancelar el pago pendiente antes de que un usuario haga el pago, si hay fallas técnicas en el sistema con la confirmación de pago o, cuando el servicio de Nequi muestra timeout o error 500 y no se puede confirmar si el usuario Nequi realizó o rechazó el pago.
Por eso, es súper importante tener la capacidad de usar este servicio.
API de pagos con suscripción:
1
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción y pantallazo que compruebe la aceptación desde la App, en el ambiente de pruebas y con un número de celular que esté activo.
Además, el request y response del servicio de consulta de estado de suscripción, que demuestre que fue aceptada.
2
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción y pantallazo que compruebe el rechazo desde la App en el ambiente de pruebas y con un número de celular que esté activo.
Además, el request y response del servicio de consulta de estado de suscripción, que demuestre que fue rechazada.
3
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción en el ambiente de pruebas y con un número de celular que esté activo, pero la suscripción debe vencerse o expirar al esperar 15 minutos.
Además, el request y response del servicio de consulta de estado de suscripción, que demuestre que expiró o no existe.
4
Request y response del servicio de una nueva suscripción de la API de pagos de suscripción, con un número de celular que no exista en ambiente de pruebas.
5
Request y response del servicio de pago automático con la API de pagos de suscripción y pantallazo del comprobante del débito desde la app, en el ambiente de pruebas y con un número de celular que esté activo.
6
Request y response del servicio de pago automático con la API de pagos de suscripción, con un monto mayor al saldo que tiene un número de cel que esté activo y exista en el ambiente de pruebas.
7
Request y response del servicio de pago automático con la API de pagos de suscripción, con una suscripción que no fue aceptada por un número de celular que esté activo y exista en el ambiente de pruebas.
8
Request y response del servicio de pago automático con la API de pagos de suscripción, con una suscripción que fue rechazada por un número de celular que esté activo y exista en el ambiente de pruebas.
9
Request y response del servicio de devolución o reverso de un pago con la API de pagos de suscripción que haya funcionado sin problema.
10
Request y response del servicio de cancelar suscripciones a un número que este activo en el ambiente de QA y que tenga la suscripción activa.
Además el request y response del estado final de la suscripción.
11
Request y response del servicio de cancelar suscripciones a un número que este activo en el ambiente de QA pero que haya cancelado la suscripción.
Además el request y response del estado final de la suscripción.
El servicio de reverso es obligatorio. Debe usarse si: se desea cancelar el pago pendiente antes de que un usuario haga el pago, si hay fallas técnicas en el sistema con la confirmación de pago o, cuando el servicio de Nequi muestra timeout o error 500 y no se puede confirmar si el usuario Nequi realizó o rechazó el pago.
Por eso, es súper importante tener la capacidad de usar este servicio.
APIs Corresponsales Nequi
API de recarga (cash in):
1
Request y Response del servicio de validación de cliente de la API de recarga (cash in) con un número de celular válido y existente en el ambiente de pruebas.
2
Request y Response del servicio de recarga de la API de recarga (cash in) y pantallazo del comprobante de recarga desde el App con un número de celular válido y existente en el ambiente de pruebas.
3
Request y Response del servicio de validación del cliente de la API de recarga (cash in) con un número de celular no existente en ambiente de pruebas.
4
Request y Response del servicio de recarga de la API de recarga (cash in) con un número de celular no existente en ambiente de pruebas.
5
Request y Response del servicio de reverso de la API de recarga (cash in) de una recarga que haya sido exitosa.
El servicio de reverso es obligatorio. Debe usarse ante fallas técnicas en tu sistema o cuando el servicio de recarga de Nequi arroje timeout o error 500, lo cual se debe hacer de manera inmediata y durante el mismo día del movimiento.
Por eso, es súper importante tener la capacidad de usar este servicio.
API de retiro (cash out):
1
Request y Response del servicio de consulta de retiro/cashout de la API de retiro (cash out) con un número de celular válido y existente en el ambiente de pruebas.
2
Request y Response del servicio de retiro de la API de retiro (cash out) y screenshot con el comprobante de retiro desde el App con un número de celular válido y existente en el ambiente de pruebas.
3
Request y Response del servicio de consulta de retiro/cashout de la API de retiro (cash out) con un número de celular no existente en ambiente de pruebas.
4
Request y Response del servicio de retiro/cashout de la API de retiro (cash out) con un número de celular no existente en ambiente de pruebas.
5
Request y Response del servicio de retiro/cashout de la API de retiro (cash out) con un token inválido en ambiente de pruebas.
6
Request y Response del servicio de reverso de la API de retiro (cash out) de un retiro/cashout que haya sido exitoso.
El servicio de reverso es obligatorio. Debe usarse ante fallas técnicas en tu sistema o cuando el servicio de recarga de Nequi arroje timeout o error 500, lo cual se debe hacer de manera inmediata y durante el mismo día del movimiento.
Por eso, es súper importante tener la capacidad de usar este servicio.
Dispersiones y Reembolsos
API de dispersiones:
1
Request y Response del servicio de la API dispersiones y screenshot con el comprobante de recarga en el App con un número de celular válido y existente en el ambiente de pruebas.
2
Request y Response del servicio de la API dispersiones con un número no existente en el ambiente de pruebas.
3
Request y Response del servicio de la API dispersiones con un valor superior a los topes de la cuenta de un número de celular válido y existente en el ambiente de pruebas.
4
Request y Response del servicio de reverso de la API dispersiones que haya sido exitosa.
El servicio de reverso es obligatorio. Debe usarse si: se desea cancelar el pago pendiente antes de que un usuario haga el pago, si hay fallas técnicas en tu sistema con la confirmación de pago o cuando el servicio de Nequi muestra timeout o error 500 y no se puede confirmar si el usuario Nequi realizó o rechazó el pago.
Por eso, es súper importante tener la capacidad de usar este servicio.
API de códigos de por plata:
1
Request y Response del servicio de generación de código de la API de códigos por plata y screenshot con el comprobante de redención del código en el App con un número de celular válido y existente en el ambiente de pruebas.
2
Request y Response del servicio de generación de código de la API de códigos por plata con un número no existente en el ambiente de pruebas de QA.
3
Request y Response del servicio de reverso de la API de una generación de código exitosa y que haya sido redimida por un usuario correctamente desde la aplicación en ambiente de pruebas.
El servicio de reverso es obligatorio. Debe usarse si desea anular la redención de un código realizada por el usuario por alguna regla de negocio.
Por eso, es súper importante tener la capacidad de usar este servicio.
Ten en cuenta que:
Para ejecutar los siguientes casos de prueba y enviar las evidencias a Nequi para la certificación, NO puedes hacerlo con los datos del comercio genérico que fueron proporcionados en el sitio de Nequi Conecta, sino con los de tu negocio.
Experiencias Embebidas
Sesión compartida:
1
Compartir la experiencia en video o pantallazos de un usuario que inició sesión en Nequi e ingresó al sitio web o App de manera exitosa.
2
Compartir la experiencia en video o pantallazos de un usuario que ingresó al sitio web o App sin un token de sesión.
API de consulta de información:
1
Compartir la experiencia en video o pantallazos y el request y response del API Consulta de información de un usuario que inició sesión en Nequi e ingresó al sitio web o app de manera exitosa.
2
Compartir la experiencia en video o pantallazos y el request y response del API Consulta de información, para un token de sesión con un token inválido y con un token expirado.
API de eventos:
Para la integración con esta API primero debemos definir los eventos a reportar durante toda la experiencia. Si aún no hemos realizado este paso, por favor comunicarse con negocios@nequi.com.
1
Compartir la experiencia en video o pantallazos y el request y response del API de eventos, para cada evento durante la experiencia en el sitio web o App.
API de pago inmediato:
1
Request y response del servicio de pago inmediato con la API y pantallazo del comprobante del débito en la experiencia y en los movimientos de Nequi, en el ambiente de pruebas y con un número de celular que esté activo.
2
Request y response del servicio de pago inmediato con la API y pantallazo, con el cobro por un monto mayor al saldo que tiene un número de celular que esté activo y exista en el ambiente de pruebas, para evidenciar el rechazo por fondos insuficientes.
3
Request y response del servicio de pago inmediato con la API y pantallazo, con el cobro a un número de celular con la sesión expirada.
4
Request y response del servicio de pago inmediato con la API y pantallazo, con el cobro a una cuenta Nequi bloqueada. Para este escenario deberás solicitar que la cuenta Nequi que está usando en el ambiente de pruebas sea bloqueada temporalmente, a través de nuestro canal de slack.
API de Reverso de pago inmediato:
Para poder ejecutar los casos prueba de esta API deberá tener pagos exitosos.
1
Request y response del servicio de devolución o reverso de un pago con la API que haya funcionado sin problema.
2
Request y response del servicio de devolución o reverso de un pago que ya haya sido reversado
3
Pantallazo de un pago y reverso donde Nequi no responde ante la petición o retornó error 500 (simular timeout).
El servicio de reverso es obligatorio. Debe usarse si: se desea cancelar el pago pendiente antes de que un usuario haga el pago, si hay fallas técnicas en tu sistema con la confirmación de pago o cuando el servicio de Nequi muestra timeout o error 500 y no se puede confirmar si el usuario Nequi realizó o rechazó el pago.
Por eso, es súper importante tener la capacidad de usar este servicio
API de Reserva de saldo:
Para poder ejecutar los casos prueba de esta API, deberás tener una reserva de saldo exitosa.
1
Request y response del servicio de devolución o reverso de una reserva de saldo que haya funcionado sin problema.
2
Request y response del servicio de devolución o reverso de una reserva de saldo que ya haya sido reversada.
3
Pantallazo de un reserva y reverso donde Nequi no responde ante la petición o retornó error 500 (simular timeout).
API de Reverso de reserva de saldo:
¡Falta por llenar!
API de Cancelación reserva de saldo:
Para poder ejecutar los casos prueba de esta API, deberás tener una reserva de saldo exitosa.
1
Request y response de la cancelación de una reserva de saldo exitosa y su pantallazo.
2
Request y response de la cancelación de una reserva previamente cancelada y el pantallazo.
API de Consulta de reserva de saldo:
1
Request y response del servicio de consulta de estado de reserva de saldo con una reserva previamente exitosa.
2
Request y response del servicio de consulta de estado de reserva de saldo con una reserva previamente cancelada.
3
Request y response del servicio de consulta de estado de reserva de saldo con una reserva vencida.
API de Confirmación de reserva de saldo:
1
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo del movimiento de Nequi, en el ambiente de pruebas y con un número de cel que esté activo.
2
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo, con el cobro por un monto mayor al saldo enviado para una reserva que exista en el ambiente de pruebas, para evidenciar el reverso de la reserva y cobro por el valor final.
3
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo, con el cobro por un monto mayor al saldo de la reserva y al saldo que tiene un número de cel que esté activo y exista en el ambiente de pruebas, para evidenciar el error por fondos insuficientes y cobro por el valor reservado previamente, retornando el valor restante que debe ser cobrado por otro medio (efectivo).
4
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo, con el cobro a un número de cel con la sesión expirada.
5
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo, con el cobro a un Nequi bloqueado. Para este escenario deberás solicitar que la cuenta Nequi que estás usando en el ambiente de pruebas sea bloqueada temporalmente, a través de nuestro canal de slack.
6
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo, con el ID de una reserva ya confirmada.
7
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo, con el ID de una reserva no existente o fallida.
3
Request y response del servicio de confirmación de reserva de saldo con la API y pantallazo, con el ID de una confirmación de reserva previamente realizada. Código repetido.
API de Reverso de confirmación de reserva de saldo:
Para poder ejecutar los casos prueba de esta API, deberás tener una confirmación de reserva de saldo exitosa.
1
Request y response del servicio de devolución o reverso de una confirmación de reserva de saldo que haya funcionado sin problema.
2
Request y response del servicio de devolución o reverso de una confirmación de reserva de saldo que ya haya sido reversada.
3
Pantallazo de un confirmación de reserva y reverso donde Nequi no responde ante la petición o retornó error 500 (simular timeout).
Ten en cuenta que:
Se debe validar en el ambiente de pruebas con número de celular, que este se encuentre activo demostrando que todo funcionó sin problemas. Tener en cuenta que dentro de los headers se deben enviar los parámetros MessageID, RequestDate, Region.
Endpoints productivos
Como te indicamos en el paso 6 inicial, debes cambiar los Endpoints para producción.Elige la API que ya certificaste:
Token de seguridad
https://oauth.nequi.com/oauth2/token?grant_type=client_credentials
Apis de Pago
Pagos con push
Unregistered Payment
https://api.nequi.com/payments/v2/-services-paymentservice-unregisteredpayment
Get Status Payment
https://api.nequi.com/payments/v2/-services-paymentservice-getstatuspayment
Reverse Transaction
https://api.nequi.com/payments/v2/-services-reverseservices-reversetransaction
Cancel unregistered payment
https://api.nequi.com/payments/v2/-services-paymentservice-cancelunregisteredpayment
API de Suscripciones
New subscription
https://api.nequi.com/subscriptions/v2/-services-subscriptionpaymentservice-newsubscription
Cancel subscription
https://api.nequi.com/subscriptions/v2/services-subscriptionpaymentservice-cancelsubscription
Get subscription
https://api.nequi.com/subscriptions/v2/-services-subscriptionpaymentservice-getsubscription
Automatic Payment
https://api.nequi.com/subscriptions/v2/-services-subscriptionpaymentservice-automaticpayment
Get Status Payment
https://api.nequi.com/subscriptions/v2/-services-subscriptionpaymentservice-getstatuspayment
Reverse Payment
https://api.nequi.com/subscriptions/v2/-services-reverseservices-reversetransaction
Reportes
API de Reportes
Get Reports
https://api.nequi.com/partners/v2/-services-reportsservice-getreports
Dispersiones y Reembolsos
API de Dispersiones
Disperse Funds
https://api.nequi.com/dispersions/v2/-services-dispersionservice-dispersefunds
Reversed dispersion
https://api.nequi.com/dispersions/v2/-services-dispersionservice-reversedispersion
API de Códigos de plata
Generate Code
https://api.nequi.com/giftcodes/v2/-services-giftcodeservices-generatecode
Reverse Redemption
https://api.nequi.com/giftcodes/v2/-services-giftcodeservices-reverseredemption
Experiencias Embebidas
API de Experiencias embebidas
Get Info
https://api.nequi.com/thirdpartyapps/v2/user/getinfo
Event send
https://api.nequi.com/thirdpartyapps/v2/event/send
Payment
https://api.nequi.com/thirdpartyapps/v2/payment
Reverse Payment
https://api.nequi.com/thirdpartyapps/v2/payment/reverse
Reserve
https://api.nequi.com/thirdpartyapps/v2/reserve
Get Reserve
https://api.nequi.com/thirdpartyapps/v2/reserve/get
Cancel Reserve
https://api.nequi.com/thirdpartyapps/v2/reserve/cancel
Confirm Reserve
https://api.nequi.com/thirdpartyapps/v2/reserve/confirm
Confirm Reverse Reserve*
https://api.nequi.com/thirdpartyapps/v2/reserve/confirm/reverse