Esta sección define los términos fundamentales que encontrarás a lo largo de la documentación. Familiarizarte con ellos te permitirá entender mejor los flujos y aprovechar al máximo las APIs de Forpay.
Roles
Empresa
Organización que contrata los servicios de Forpay para automatizar su recaudación. Es quien crea los compromisos de pago, define las reglas de cobro y recibe las notificaciones de estado a través de webhooks.
Cliente
Persona natural o jurídica que tiene un compromiso de pago con la Empresa. Forpay le realiza los cobros según las condiciones pactadas. El cliente interactúa con el sistema principalmente a través del Magic Link para activar su medio de pago.
Compromiso de pago
Acuerdo formal entre una Empresa y un Cliente que autoriza a Forpay a realizar cobros de forma recurrente o puntual. Cada compromiso define las reglas del cobro: monto, periodicidad, cantidad de cuotas, medios de pago permitidos, etc.
Los tipos de compromisos disponibles mediante API son: Mandato Dinámico, Mandato Permanente, Mandato Suscripción y Botón de Pago. Ver Compromisos de pago para más detalle.
Motor de Cobro
Sistema automatizado de Forpay que ejecuta diariamente los cobros de las cuotas vencidas. Gestiona los reintentos en caso de fallo y notifica a la Empresa el resultado de cada intento a través del paymentWebhook.
Medios de Pago
Forpay permite ofrecer distintos medios de pago al cliente final. Los disponibles son:
Tarjetas bancarias (PAT)
Cobro automático mediante tokenización de tarjetas de crédito, débito y prepago. Se procesan a través de Transbank Oneclick o Getnet Click.
Cuentas bancarias (PAC)
- ForPAC: PAC suscrito mediante Clave Única. Incluye mandato firmado con firma electrónica avanzada. La activación puede ser inmediata o demorar hasta 24 horas hábiles dependiendo del banco.
- EPAC Directo: PAC suscrito mediante credenciales bancarias.
Transferencias electrónicas (TEF)
Pagos mediante transferencia bancaria preconciliada a través de ETPay.
Pago inmediato con tarjeta
Cobro en tiempo real mediante Webpay Plus (Transbank) o Web Checkout (Getnet). No requiere tokenización previa.
Magic Link
Enlace único que Forpay genera al crear un mandato recurrente (Permanente, Dinámico o Suscripción). El cliente lo usa para revisar las condiciones de su compromiso y enrolar su medio de pago, habilitando así los cobros automáticos futuros.
- Diseño mobile first, 100% personalizado por cliente y compromiso.
- Puede enviarse al correo electrónico del cliente o retornarse directamente en la respuesta de la API para que la Empresa lo gestione.
- Una vez que el cliente activa su compromiso a través del Magic Link, Forpay notifica a la Empresa vía
activationWebhook.
Link de pago / Botón de pago
Enlace que Forpay genera al crear un compromiso de tipo OnePay (cobro puntual). A diferencia del Magic Link, aquí el cliente no enrola un medio de pago recurrente: simplemente completa el pago en el momento y el compromiso se cierra automáticamente.
- No genera futuros cobros automáticos.
- El resultado del cobro se notifica vía
paymentWebhookinmediatamente después del intento.
Webhooks
URLs definidas por la Empresa que Forpay utiliza para notificar eventos asincrónicos:
activationWebhook: notifica activaciones y anulaciones de compromisos de pago.paymentWebhook: notifica el resultado de cada intento de cobro de una cuota.
Ambos webhooks se configuran individualmente por cada compromiso en el momento de su creación. Ver Introducción a Webhooks para más detalle.
Cuota (Installment)
Unidad de cobro dentro de un compromiso de pago. Cada cuota tiene un monto, una fecha de vencimiento y un estado. El motor de cobro de Forpay procesa las cuotas según su fecha y notifica el resultado al paymentWebhook.