Introducción

¡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                          Forpay
─────────────────────────────────────────────────────────
1. Autenticación     →   POST /white/label/login   →  JWT (30 min)
2. Crear cliente     →   POST /white/label/user
3. Crear mandato     →   POST /white/label/mandate
                     ←   Retorna Magic Link
4. Cliente activa    →   (cliente usa Magic Link)
                     ←   POST activationWebhook    →  Tu webhook
5. Motor de cobros   →   (Forpay cobra cuotas)
                     ←   POST paymentWebhook       →  Tu webhook

Todos los endpoints comparten la ruta base:

https://devapi.forpayservices.cl/white/label

Primeros pasos

Si estás comenzando tu integración, te recomendamos seguir este orden:

1. Lee Conceptos clave para entender los términos del dominio.
2. Revisa Compromisos de pago para elegir el producto que mejor se adapta a tu caso de uso.
3. Consulta ¿Qué puedes hacer con las APIs? para entender el flujo completo.
4. Sigue ¿Cómo usar las APIs? para implementar cada paso técnicamente.
5. 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.