Descripción general

La API de Hyfin conecta tu software con Hyfin, para que los comerciantes que la usan reciban sus pagos más rápido sin capturar nada dos veces.

Sigues creando orden de compra donde lo haces hoy. Hyfin envía cada uno al cliente por mensaje de texto o correo electrónico, el cliente paga desde su teléfono o cualquier dispositivo sin instalar ninguna app, y Hyfin se encarga de los recordatorios, las comisiones y los descuentos por pago en efectivo. Cuando entra el dinero, Hyfin avisa a tu software, de modo que orden de compra se marca como pagado en ambos lados.

Cómo funciona una integración

Tu software
Hyfin
Tu cliente
1 Add/Update Customer y Orden de compra
Guarda el _id de cada respuesta
2 Mensaje de texto o correo electrónico con un enlace de pago
3 Paga con tarjeta o cuenta bancaria
4 Webhook de pago
allocations[].ref es el _id de la orden de compra
5 Get Orden de compra, Get Payment
Por _id, cuando lo necesites

1. Envía clientes y órdenes de compra

Llama a Agregar/Actualizar Cliente cuando se cree un cliente o cambie en tu software, y a Agregar/Actualizar Orden de compra cuando una orden de compra esté lista. Cada respuesta devuelve el _id de Hyfin para el registro. Guárdalo junto a tu propio registro.

Para actualizar el registro más adelante, vuelve a enviar ese _id. Sin él, Hyfin actualiza el registro con el mismo externalId, o agrega uno nuevo si ninguno coincide.

2. Hyfin envía la orden de compra y cobra

Hyfin envía la orden de compra por mensaje de texto o correo electrónico con un enlace de pago. Tu cliente paga con tarjeta o cuenta bancaria desde cualquier dispositivo, sin instalar ninguna app. Hyfin envía recordatorios y aplica cargos o descuentos por pago en efectivo cuando el comercio los tiene activados.

3. Un webhook avisa a tu software

Cuando un pago alcanza un nuevo estado, Hyfin lo envía al webhookUrl de la orden de compra, o a la URL de webhook del sitio cuando la orden de compra no tiene una. Cada entrada en allocations nombra en ref la orden de compra que pagó, que es el _id de la orden de compra que guardaste. Úsalo para marcar la orden de compra como pagada en tu software.

4. Consúltalo cuando lo necesites

Get Invoice y Get Payment devuelven un registro por su _id. Los endpoints de lista devuelven los registros que cambiaron después de updated_after, que es como te pones al día después de que tu software estuvo fuera de línea.

Inicio rápido lleva tu primera orden de compra de enviada a pagada.

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.