API Reference

Para operar de manera óptima con Forpay, debes integrar al menos los siguientes pasos fundamentales:

  1. Creación de Clientes: La empresa debe crear los clientes a los que desea cobrarle. Para esto se necesita de forma obligatoria el nombre, apellido, rut y correo electrónico del cliente. El rut será el identificador único del cliente en nuestra plataforma. Este proceso se realiza una vez por cliente, es decir, si se quiere asignar más de un Compromisos de pago por cliente, no es necesario crearlo nuevamente.
  2. Creación de Compromisos de Pago: Inicialmente, la empresa que integra Forpay genera Compromisos de pago, cada uno asociado a un cliente. Para esto es necesario haber creado previamente al cliente.
  3. Activación de Compromisos de Pago: Para realizar cobros a un cliente, es necesario que este acepte y active el Compromiso de Pago. El cliente puede hacer esto a través de nuestro Magic Link, donde se le presentan los diferentes medios de pago que la empresa tiene habilitados. A través de este enlace, el cliente puede seleccionar y registrar un medio de pago específico asociado al compromiso, asegurando así la correcta automatización de los cobros.
  4. Proceso de Cobro de Cuotas: Forpay lleva a cabo el proceso de cobro de las cuotas correspondientes a los Compromisos de pago previamente creados y activados. Este procedimiento incluye notificaciones a las empresas vía webhook sobre los resultados de los intentos de cobro.

Cabe mencionar que, además de estos pasos esenciales, existen procesos adicionales diseñados para enriquecer y personalizar la experiencia de integración. Estos procesos se pueden encontrar en el ítem procesos adicionales.

Creación y Activación

El flujo principal para la creación y activación de Compromisos de pagos se representa de manera gráfica en el siguiente esquema. Este consta de 4 etapas: creación de usuario, creación de Compromiso de pago, aceptación de compromiso de pago por parte del cliente final y recepción de notificación de activación.

Carga de cuotas en mandatos (solo para Mandatos Dinámicos)

Para los compromiso de tipo Mandato Dinámico, existe la posibilidad de cargarle cuotas después de su creación. Para llevar a cabo este proceso, es necesario seguir el siguiente flujo:

Proceso de cobro automático

El proceso de cobro automático de los Compromisos de pago es gestionado por el motor de cobros de Forpay. Este procedimiento implica la ejecución diaria de cargos que correspondan a los medios de pago asociados por el cliente final. Posterior a cada ejecución de cobros, se notifica a la empresa los resultados obtenidos durante el proceso de cobro.

Procesos Adicionales

  • Búsqueda de información de un Mandato
    Existe la posibilidad de consultar toda la información relacionada al Compromiso de pago, incluyendo información del cliente y de las cuotas asociadas.
  • Cambio de estado de cuotas
    Se ofrece la opción de modificar el estado interno de una cuota en Forpay, permitiendo específicamente marcarla como pagada o anulada. Este proceso resulta útil para conciliar pagos y garantizar que los estados de las cuotas en Forpay reflejen de manera precisa los cambios realizados externamente.
  • Anulación de compromiso de pago
    Se proporciona la opción de cancelar un Compromiso de pago creado en Forpay desde fuentes externas. En otras palabras, si se desea detener el cobro de un compromiso, el proceso a seguir es la anulación del Compromiso de pago.