Skip to main content

Intégration API

Le lien de paiement utilise l’API HUB2. Les endpoints disponibles sont listés dans la documentation suivante :

API Payment Links

Authentification

Votre intégration utilise les mêmes clés API HUB2 pour l’authentification. La clé doit disposer des permissions suivantes :
  • Api.payment_intent_create : créer et fermer des liens de paiement
  • Api.payment_intent_read : consulter et lister les liens de paiement

Configuration des permissions

Endpoints API

Lien de paiement

  • POST /payment-links : créer un lien de paiement en définissant les moyens de paiement et les opérateurs acceptés. L’intention de paiement et le paiement sont créés au fil du parcours du client sur la page de paiement. Exemple :
  • type vaut single_use par défaut (un seul paiement réussi). Utilisez multi_use pour accepter plusieurs paiements, éventuellement plafonnés par maximumPayments.
  • Si expirationDate est absent ou déjà passé, le lien expire 15 minutes après sa création.
  • successUrl et failureUrl doivent utiliser le schéma https.
  • PATCH /payment-links/{id}/close : fermer un lien de paiement avant son expiration
  • GET /payment-links : lister les liens de paiement créés
  • GET /payment-links/{id} : consulter un lien de paiement et ses tentatives de paiement

Webhooks

Le lien de paiement utilise les mêmes webhooks que les paiements. Si vous avez déjà configuré des webhooks pour les paiements, aucune étape supplémentaire n’est requise. Sinon, consultez :

Guide d'intégration des webhooks