Aperçu

L'API Hyfin connecte votre logiciel à Hyfin, afin que les commerçants qui l'utilisent soient payés plus rapidement sans avoir à saisir quoi que ce soit en double.

Vous continuez de créer vos Factures là où vous le faites aujourd'hui. Hyfin envoie chacune au client par texto ou par courriel, le client paie depuis son téléphone ou tout autre appareil sans application à installer, et Hyfin gère les rappels, les frais et les escomptes de caisse. Lorsque l'argent entre, Hyfin en informe votre logiciel, de sorte que la Facture est marquée comme payée des deux côtés.

Comment fonctionne une intégration

Votre logiciel
Hyfin
Votre client
1 Add/Update Customer et Facture
Enregistrez l'_id de chaque réponse
2 Texto ou courriel avec un lien de paiement
3 Paie par carte ou par compte bancaire
4 Webhook de paiement
allocations[].ref est l'_id de la facture
5 Get Facture, Get Payment
Par _id, lorsque vous en avez besoin

1. Envoyer les clients et les factures

Appelez Ajouter/Mettre à jour un client lorsqu'un client est créé ou modifié dans votre logiciel, et Ajouter/Mettre à jour une Facture lorsqu'une facture est prête. Chaque réponse renvoie le _id de Hyfin pour l'enregistrement. Conservez-le à côté de votre propre enregistrement.

Pour mettre à jour l'enregistrement plus tard, envoyez de nouveau le même externalId. Conservez aussi le _id : les webhooks de paiement s'en servent pour désigner les factures.

2. Hyfin envoie la facture et perçoit le paiement

Hyfin envoie la facture par texto ou par courriel avec un lien de paiement. Votre client paie par carte ou par compte bancaire depuis n'importe quel appareil, sans application à installer. Hyfin envoie des rappels et applique des frais ou des escomptes de caisse lorsque le commerçant les a activés.

3. Un webhook avise votre logiciel

Lorsqu'un paiement atteint un nouveau statut, Hyfin l'envoie au webhookUrl de la facture, ou à l'URL de webhook du site si la facture n'en a pas. Chaque entrée de allocations indique dans ref la facture qu'elle a payée, soit le _id de la facture que vous avez enregistré. Utilisez-le pour marquer la facture comme payée dans votre logiciel.

4. Relire les enregistrements

4.0 Simple n'a pas de points de terminaison de lecture. Pour relire un enregistrement, utilisez les points de terminaison Get de la 4.0 avec le _id que vous avez enregistré. Ils utilisent les mêmes URL /api/v4/ et le même jeton.

Démarrage rapide mène votre première facture de l'envoi au paiement.

La version 4.0 Simple n'a aucun point de terminaison de lecture. Pour relire un enregistrement, utilisez les points de terminaison Get 4.0 avec l'_id retourné par Add/Update. Ils utilisent les mêmes URL /api/v4/ et le même jeton.

Un jeton d'accès API est requis pour accéder à l'API. Veuillez visiter le Authentification Section pour obtenir et utiliser des jetons d'accès API.