Aller au contenu

Outil en ligne de commande

xaalis fait depuis un terminal ce que fait l’API : créer un paiement et son lien de paiement, attendre qu’il soit vraiment payé, rembourser, verser, lire votre solde et vérifier la signature d’un webhook hors ligne. Il sert aux personnes, aux scripts et aux agents IA : chaque commande peut afficher le JSON de l’API (--json) et renvoie un code de sortie qui a du sens.

Node.js 20 ou plus récent.

Fenêtre de terminal
npm install -g https://docs.xaalis.org/downloads/xaalis-cli-0.1.0.tgz # ou, une fois publié : npm install -g @xaalis/cli
xaalis --help

Sans installation : npx https://docs.xaalis.org/downloads/xaalis-cli-0.1.0.tgz --help. Vérifiez le fichier avec SHA256SUMS — voir Téléchargements.

Fenêtre de terminal
xaalis signup --email vous@exemple.com --business "Boutique Awa" # un compte sandbox : clés de test, affichées une fois
export XAALIS_API_URL=https://sandbox-api.xaalis.org
export XAALIS_API_KEY=sk_test_…
xaalis payments create --amount 5000 --description "Robe bleue" # affiche le lien de paiement
xaalis payments simulate pay_… --outcome succeeded # clés de test : jouez le client
xaalis payments wait pay_… # code 0 une fois vraiment payé
xaalis balance
Commande Ce qu’elle fait
signup --email --business [--webhook-url] Crée un compte sandbox (POST /v1/sandbox/signups) et affiche une seule fois sa clé secrète de test et son secret de webhook
balance Solde disponible et versements en cours
payments create --amount [--description] [--reference] [--phone] [--provider wave|orange_money] [--success-url] [--cancel-url] Crée un paiement et affiche son lien de paiement hébergé
payments get <pay_…> · payments list [--limit] [--status] Lit les paiements
payments wait <pay_…> [--timeout 300] Attend que le paiement soit définitif ; code 0 seulement s’il a réussi
payments simulate <pay_…> --outcome succeeded|failed Clés de test seulement : accepte ou refuse comme le ferait le client
refunds create <pay_…> [--confirm] · refunds list <pay_…> Rembourse un paiement (Remboursements)
payouts create --amount --phone [--provider] [--name] [--reference] [--confirm] · payouts get <po_…> · payouts list Verse vers un portefeuille (Versements) ; les frais s’ajoutent au montant
webhooks verify --signature <en-tête> [--secret] [--payload-file] Vérifie hors ligne la Xaalis-Signature d’un webhook ; le contenu vient du fichier ou de l’entrée standard
  • Clé : XAALIS_API_KEY, ou --key (elle finit alors dans l’historique du shell). La clé n’est jamais affichée.
  • API : XAALIS_API_URL ou --api-url ; par défaut https://api.xaalis.org. Les comptes sandbox utilisent https://sandbox-api.xaalis.org.
  • Montants en F CFA entiers : 5000 ou "5 000", jamais 5000.50 — refusé avant toute requête.
  • Nouvelles tentatives : chaque écriture envoie un Idempotency-Key. Passez le vôtre avec --idempotency-key, ou réutilisez celui que la commande affiche, pour réessayer sans créer un deuxième paiement ou versement (Idempotence).
  • Argent réel : refunds create et payouts create avec une clé live refusent de s’exécuter sans --confirm.
  • Livraison : une page de paiement qui affiche « payé » ne prouve rien. Livrez sur le webhook signé payment.succeeded (Webhooks) ou quand xaalis payments wait renvoie 0.
  • Codes de sortie : 0 fait · 1 refusé par Xaalis (le code d’erreur est affiché), échoué ou délai dépassé · 2 erreur d’utilisation.

Aide : contact@xaalis.org.