Introducción

Bienvenido a la versión 3.0 de la API de Hyfin. La API permite que aplicaciones de terceros envíen solicitudes de pago a clientes a través de mensaje de texto, correo electrónico o ambos. Una vez recibido, el cliente puede ver y pagar la orden de compra desde su teléfono móvil o cualquier dispositivo sin necesidad de descargar e instalar una aplicación.

Se requiere un token de acceso a la API para acceder a la API. Por favor visita el Autenticación Sección para detalles sobre cómo obtener y usar tokens de acceso a la API.

Onboarding

La plataforma Hyfin tiene soporte para múltiples niveles de acceso. A continuación se presentan las definiciones de las estructuras comerciales disponibles dentro de la API junto con cómo se relacionan entre sí.

Estructura de Nivel

La siguiente tabla representa algunos ejemplos en los que puedes configurar la estructura para tus Sitios.

Sitio

Una vez que se haya creado un sitio utilizando la API Hyfin y se haya asignado el site_id, entonces puedes llamar a cualquiera de los puntos finales del nivel del sitio.

Los APIs a nivel de Sitio pueden ser utilizados para agregar o actualizar facturas dentro de la aplicación Hyfin. Cuando el orden de compra es agregado a Hyfin, una solicitud de pago será generada automáticamente y el cliente será notificado vía mensaje de texto, correo electrónico o ambos basado en las opciones de notificación establecidas en el registro del cliente.

Si el cliente está viendo el orden de compra en su dispositivo y se actualiza, se mostrará un mensaje informando al cliente que el orden de compra ha sido actualizado y la nueva versión del orden de compra se mostrará automáticamente en el dispositivo del cliente.