> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mercy-pay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ligne de commande

> Recevez vos webhooks sur votre ordinateur, déclenchez des événements de test et appelez l'API depuis le terminal.

`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

```sh Homebrew theme={"theme":{"light":"github-light","dark":"github-dark"}}
brew install mercy-pay/tap/mercypay
```

```sh Script (macOS, Linux) theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -fsSL https://raw.githubusercontent.com/mercy-pay/cli/main/install.sh | sh
```

Sur Windows, téléchargez l'archive `.zip` de la [dernière version](https://github.com/mercy-pay/cli/releases/latest). Le code est sur [GitHub](https://github.com/mercy-pay/cli).

## Se connecter

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
mercypay login
```

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

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
mercypay listen --forward-to localhost:8000/webhooks/mercy-pay
```

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](https://docs.mercy-pay.com/developers/webhooks/handle.md), 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.

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
Prêt. Secret de signature : whsec_JM2tVs76kjj6pDtLWaIdXqJXlBKTc98L
Les événements sont relayés à http://localhost:8000/webhooks/mercy-pay. Ctrl+C pour arrêter.
10:35:14  payment.succeeded              evt_01M7HVBWFJCX7X6MRNX4SV867P  [200]
```

* 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

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
mercypay trigger payment.succeeded
mercypay trigger --list
```

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](https://docs.mercy-pay.com/start/environments.md).

Vous pouvez aussi déclencher un événement sans la CLI, avec [`POST /api/v1/test_helpers/events`](https://docs.mercy-pay.com/api/events/trigger).

## Suivre vos appels à l'API

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
mercypay logs tail
mercypay logs tail --status error --path payments
```

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](https://docs.mercy-pay.com/developers/console.md).

## Appeler l'API

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
mercypay payments list -d limit=5
mercypay payments get pay_5e0c8a7b3d1f4a2e9c648b7f0d2e1a93
mercypay customers create -d name="Awa Ndiaye" -d email=awa@example.com
mercypay checkout-sessions create -d amount:=15000 -d currency=XAF -d metadata[order_id]=4821
mercypay get /v1/account
```

Chaque endpoint de la [référence](https://docs.mercy-pay.com/api/account/get.md) a sa commande, `mercypay <ressource> <action>`. `mercypay get`, `post`, `patch` et `delete` appellent n'importe quel chemin.

| Écriture | Envoie |
| - | - |
| `-d nom=Ada` | du texte |
| `-d amount:=15000` | du JSON : un nombre, `true`, `null`, une liste ou un objet |
| `-d metadata[order_id]=4821` | un champ d'objet |
| `-d events[]=payment.succeeded` | un élément de liste |

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 :

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
mercypay login --profile boutique-2
mercypay payments list --profile boutique-2
```

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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.