Skip to main content
Un webhook est une requête POST que Mercy Pay envoie à une URL de votre serveur dès qu’un statut change. Vous n’avez donc pas besoin d’interroger l’API en boucle.

Configurer un endpoint

Ouvrez l’onglet Webhooks de la console Développeurs :
  1. Saisissez une URL HTTPS publique qui accepte les requêtes POST.
  2. Choisissez l’environnement écouté : Sandbox, Live ou les deux.
  3. Cochez les événements à recevoir.
  4. Copiez le secret de signature (whsec_…).
Vous pouvez déclarer plusieurs endpoints. Chacun a son propre secret et ses propres événements.

Format d’une livraison

Le corps est un événement : id, object, type, created, livemode et data. Le contenu de data reprend la ressource correspondante : un paiement pour payment.*, un retrait pour payout.*, une session pour checkout_session.*, un abonnement pour subscription.* et invoice.upcoming, une facture pour les autres invoice.*. Voir Événements.

Fiabilité

  • Mercy Pay attend une réponse 2xx dans les 10 secondes.
  • Sinon, Mercy Pay réessaie, jusqu’à 8 tentatives sur 3 jours.
  • Un endpoint qui n’a accepté aucun événement pendant 3 jours est désactivé, et vos développeurs sont prévenus par e-mail.
  • Une livraison en échec peut être renvoyée depuis la console, une par une ou toutes celles des 3 derniers jours, ou avec POST /api/v1/events/{id}/resend.
  • Envoyer un test dans la console, ou POST /api/v1/webhook_endpoints/{id}/test, envoie un événement webhook.test pour vérifier votre serveur.
  • Un même événement peut être livré plusieurs fois : dédupliquez-le avec son id.
Pour la mise en œuvre pas à pas, voir Gérer les webhooks.