Skip to main content
mercypay est la ligne de commande de Mercy Pay. Elle sert pendant le développement : tester un gestionnaire de webhooks en local sans l’exposer sur Internet, provoquer un événement précis, suivre vos appels à l’API.

Installer

Sur Windows, téléchargez l’archive .zip de la dernière version. Le code est sur GitHub.

Se connecter

  1. Votre navigateur s’ouvre sur Mercy Pay. Connectez-vous si besoin.
  2. Vérifiez que le code affiché est celui de votre terminal.
  3. Choisissez la boutique, puis Autoriser la CLI.
La CLI reçoit une clé de sandbox nommée CLI <nom de votre ordinateur>, rangée dans le trousseau de votre système. Seuls les propriétaires, administrateurs et développeurs d’une boutique peuvent l’autoriser. La clé se révoque dans Développeurs, onglet Clés API, comme les autres. Pour travailler avec une autre clé, live comprise, passez-la vous-même : mercypay login --api-key mp_live_…, l’option --api-key sur n’importe quelle commande, ou la variable MERCYPAY_API_KEY. mercypay status affiche le compte et l’environnement de la clé utilisée.

Recevoir vos webhooks en local

Chaque nouvel événement du compte est envoyé en POST à cette adresse, avec le même corps et les mêmes en-têtes qu’un vrai webhook, signé avec MercyPay-Signature. Votre code de vérification n’a rien à changer. Le secret de signature s’affiche au démarrage. Il reste le même d’un lancement à l’autre : mettez-le dans la configuration de votre application locale à la place du secret de votre endpoint. mercypay listen --print-secret l’affiche seul.
  • La CLI lit les nouveaux événements toutes les 2 secondes. Rien n’a besoin d’être ouvert sur votre réseau.
  • --events payment.succeeded,payment.failed ne relaie que ces types.
  • Sans --forward-to, les événements s’affichent seulement.
  • Vos endpoints enregistrés continuent de recevoir les événements comme d’habitude.

Déclencher un événement de test

En sandbox seulement. L’événement porte des données d’exemple au format exact de l’objet réel, et part vers vos endpoints sandbox et vers mercypay listen. Rien d’autre n’est créé : pas de paiement, pas de mouvement de solde. Les identifiants ne renvoient à aucun objet, et metadata.test_helper vaut true quand l’objet a des métadonnées. Pour tester un parcours complet, avec un vrai paiement en sandbox, utilisez plutôt les numéros de test. Vous pouvez aussi déclencher un événement sans la CLI, avec POST /api/v1/test_helpers/events.

Suivre vos appels à l’API

Chaque appel fait avec les clés du compte, dans l’environnement de la clé, s’affiche quelques secondes après sa réponse : statut, méthode, chemin, durée, code d’erreur et Request-Id. Les corps des requêtes restent dans la console développeurs.

Appeler l’API

Chaque endpoint de la référence a sa commande, mercypay <ressource> <action>. mercypay get, post, patch et delete appellent n’importe quel chemin. Un POST porte toujours une Idempotency-Key : si la CLI relance la requête après une coupure ou une erreur 5xx, rien n’est créé en double. -i ma-cle choisit la clé. La réponse s’affiche en JSON ; en cas d’erreur, la commande se termine avec le code 1 et affiche le Request-Id.

Plusieurs boutiques

--profile garde une connexion séparée par boutique :
La configuration est dans ~/.config/mercypay/config.json. Les clés sont dans le trousseau du système, ou dans ce fichier, lisible par vous seul, quand il n’y en a pas.