¡Hola! 👋 Bienvenido a la documentación de las APIs de Forpay
Forpay es una plataforma B2B2C diseñada para automatizar la recaudación y gestión de compromisos de pago recurrentes. Ayudamos a empresas de sectores como inmobiliario, educación, seguros, créditos y fundaciones a manejar de forma eficiente sus ingresos recurrentes, integrando servicios financieros con los principales bancos y fintechs del país.
¿Qué encontrarás en esta documentación?
Esta documentación cubre todo lo necesario para integrarte con Forpay mediante APIs:
- Conceptos y productos: definiciones clave, tipos de compromisos de pago y medios de pago disponibles.
- Flujos de integración: cómo crear usuarios, compromisos, cargar cuotas y recibir notificaciones.
- Referencia de endpoints: detalle técnico de cada API con ejemplos de request y response.
- Webhooks: estructura de notificaciones de activación y cobro, verificación HMAC y buenas prácticas.
- Ambiente de desarrollo: credenciales y datos de prueba para validar tu integración antes de producción.
Arquitectura general
La integración con Forpay sigue este flujo de alto nivel:
Tu sistema registra al cliente y crea el compromiso de pago.
El cliente utiliza el enlace de inscripción o de pago, según el producto.
Las cuotas se crean o generan según el tipo de compromiso.
Forpay comunica los eventos habilitados a tu integración.La secuencia numerada y sus variantes se explican en ¿Cómo usar las APIs?.
URL base y rutas
Usa FORPAY_BASE_URL para representar la URL base del ambiente de tu integración:
| Ambiente | FORPAY_BASE_URL |
|---|---|
| Desarrollo | https://devapi.forpayservices.cl/white/label |
| Producción | https://api.forpayservices.cl/white/label |
Las rutas de esta documentación son relativas a esa base. Por ejemplo, POST /login en desarrollo corresponde a:
POST https://devapi.forpayservices.cl/white/label/loginEl prefijo /white/label ya está incluido en FORPAY_BASE_URL. Usa las credenciales, la API key, el comercio, el canal y los permisos del mismo ambiente. V2.0 es la versión de la documentación y no agrega un segmento /v2 a la URL.
Las URLs activationWebhook, paymentWebhook y callback pertenecen a tu integración: no se forman con FORPAY_BASE_URL. Forpay envía las notificaciones a las URLs de webhook que configures en tu propio dominio.
Primeros pasos
Si estás comenzando tu integración, te recomendamos seguir este orden:
- Lee Conceptos clave para entender los términos del dominio.
- Revisa Compromisos de pago para elegir el producto que mejor se adapta a tu caso de uso.
- Consulta ¿Qué puedes hacer con las APIs? para entender el flujo completo.
- Sigue ¿Cómo usar las APIs? para implementar cada paso técnicamente.
- Configura tus Webhooks para recibir notificaciones de activación y cobro.
Soporte
Si tienes dudas o encuentras algún problema durante tu integración, contáctanos a través de tu ejecutivo Forpay asignado.