Nequi

(0 reviews)

Esta API permite el procesamiento y la gestión de pagos no registrados, incluyendo la iniciación de pagos, la verificación de estado, las reversiones y las cancelaciones para transacciones de Nequi.

🛡️ cs-nequi-sapi

La API cs-nequi-sapi es una API de Sistema (SAPI) que procesa pagos a través de la plataforma Nequi, permitiendo la integración controlada con los servicios de pago de Nequi para operaciones transaccionales.

Expone operaciones REST para:

Inicio, consulta de estado, reverso y cancelación de pagos para usuarios no registrados
Creación y consulta de suscripciones de pago automático
Pago automático, reverso y cancelación de suscripciones
Consulta de reportes de transacciones

La API actúa como una System API (SAPI), gestionada desde MuleSoft Anypoint Platform.

🌐 Información Básica

Nombre de la API: cs-nequi-sapi
Versión: 1.0.0
Plataforma: MuleSoft Anypoint Platform
Tipo: System API
URL Base QA:https://cs-nequi-sapi-qa-v1.us-e1.cloudhub.io/api/
Protocolo: HTTPS / REST
Formato de Datos: JSON

🔐 Autenticación

Para consumir esta API, el consumidor debe enviar obligatoriamente en cada solicitud los siguientes mecanismos de seguridad:

Client ID Enforcement
- Headers requeridos:
  - client_id
  - client_secret
- Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform.
Bearer Token (OAuth 2.0)
- Header requerido:
  - Authorization: Bearer <access_token>
- El token debe ser obtenido desde el servicio corporativo de autenticación.
- El token debe estar vigente al momento de la solicitud.

Ambos mecanismos son requeridos para que la solicitud sea aceptada por la plataforma.

🔒 Aviso de Seguridad
Las credenciales (client_id, client_secret) y los tokens OAuth son información sensible y no deben compartirse ni almacenarse en repositorios públicos.

🚀 Cómo Consumir

La API se encuentra publicada en las siguientes plataformas:

🔗 MuleSoft Exchange – cs-nequi-sapihttps://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/2b26d155-74f8-4cf2-aaea-ec3c05e8433a/cs-nequi-sapi/
🔗 Portal Público FGShttps://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/

📋 Para consultar detalles de cada método:

Navegar en el menú izquierdo de la documentación
Expandir la sección "Summary"
Seleccionar el método específico que requiere consultar

📍 Endpoints Disponibles

Método	Endpoint	Descripción
POST	`/payments/unregistered`	Iniciar un pago para un usuario no registrado
POST	`/payments/unregistered/status`	Consultar el estado de un pago no registrado
POST	`/payments/unregistered/reverse`	Reversar un pago no registrado
POST	`/payments/unregistered/cancel`	Cancelar un pago no registrado
POST	`/subscriptions/automatic-payments`	Realizar el pago automático de una suscripción
POST	`/subscriptions/new-subscription`	Crear una nueva suscripción
GET	`/subscriptions/get-subscription`	Consultar el estado de una suscripción
POST	`/subscriptions/reversals`	Reversar una transacción de suscripción que no se completó exitosamente
POST	`/subscriptions/cancel-subscription`	Cancelar una suscripción
GET	`/reports/transactions`	Consultar el reporte de transacciones de pagos Nequi

⚠️ Manejo de Errores

La API utiliza códigos HTTP estándar para indicar el resultado del procesamiento de las solicitudes.

Estos códigos representan condiciones de autenticación, autorización, formato o disponibilidad del servicio, y no validaciones funcionales propias del negocio.

Código	Estado	Descripción
200	OK	Solicitud procesada correctamente
400	Bad Request	Solicitud inválida o mal formada
401	Unauthorized	Credenciales inválidas o ausentes
403	Forbidden	Client ID sin permisos
404	Not Found	Recurso no encontrado
405	Method Not Allowed	Método HTTP no permitido
415	Unsupported Media Type	Tipo de contenido no soportado
429	Too Many Requests	Límite de solicitudes excedido
500	Internal Server Error	Error interno inesperado
503	Service Unavailable	Servicio temporalmente no disponible
504	Gateway Timeout	Tiempo de espera agotado

📞 Soporte

Para soporte técnico o incidencias relacionadas con la integración:

Coordinación de Servicios de Integración y Aplicaciones

📅 Información Adicional

Documentación actualizada en Febrero 2026 – Fundación Grupo Social – Colmena

Esta documentación se mantiene actualizada conforme se incorporan nuevos servicios o endpoints relacionados con los pagos Nequi.

home