Aller au contenu principal

Référence des commandes

Référence complète de toutes les commandes du CLI ikw. Chaque commande prend en charge les flags globaux (--json, --dry-run, --debug, --trace, --request-id, --idempotency-key).

payments​

Gérer les PaymentIntents.

ikw payments <subcommand>
Sous-commandeDescription
listLister les payment intents
inspect <id>Inspecter un payment intent
createCréer un payment intent
confirm <id>Confirmer un payment intent
cancel <id>Annuler un payment intent
refund <id>Rembourser un paiement
refunds <id>Lister les remboursements d’un paiement

payments create​

ikw payments create \
--amount 5000 \
--currency XOF \
--description "Order #123" \
--customer cus_abc123 \
--metadata '{"order_id": "123"}'
FlagRequisDescription
--amount <n>✅Montant dans la plus petite unité monétaire
--currency <code>✅Code devise (ex. XOF)
--description <text>Description du paiement
--metadata <json>Objet JSON de métadonnées
--customer <id>Identifiant client
--customer-email <email>Email du client
--customer-phone <phone>Téléphone du client

payments confirm​

ikw payments confirm pi_abc123 \
--type mobile_money \
--mm-country CI \
--mm-operator orange_ci \
--mm-msisdn +2250700000001
FlagRequisDescription
--type <type>✅mobile_money ou card
--mm-country <code>Pays mobile money
--mm-operator <code>Opérateur mobile money
--mm-msisdn <phone>Numéro mobile money
--card-token <token>Jeton carte
--return-url <url>URL de retour pour le 3DS

payments refund​

ikw payments refund pi_abc123 --amount 2500 --reason "Customer request"
FlagDescription
--amount <n>Montant du remboursement partiel (par défaut : total)
--reason <text>Motif du remboursement

customers​

Gérer les clients.

ikw customers <subcommand>
Sous-commandeDescription
listLister les clients
inspect <id>Inspecter un client
createCréer un client
update <id>Mettre à jour un client
delete <id>Supprimer un client

customers create​

ikw customers create \
--name "Aminata Koné" \
--email aminata@example.com \
--phone +2250700000000

payouts​

Gérer les payouts.

ikw payouts <subcommand>
Sous-commandeDescription
listLister les payouts
inspect <id>Inspecter un payout
createCréer un payout
cancel <id>Annuler un payout

payouts create​

ikw payouts create \
--amount 50000 \
--currency XOF \
--type mobile_money \
--phone +2250700000000 \
--operator orange_ci

invoices​

Gérer les factures.

ikw invoices <subcommand>
Sous-commandeDescription
listLister les factures
inspect <id>Inspecter une facture
createCréer une facture
finalize <id>Finaliser une facture brouillon
void <id>Annuler une facture

subscriptions​

Gérer les abonnements.

ikw subscriptions <subcommand>
Sous-commandeDescription
listLister les abonnements
inspect <id>Inspecter un abonnement
createCréer un abonnement
cancel <id>Annuler un abonnement

products​

Gérer les produits et les prix.

ikw products <subcommand>
Sous-commandeDescription
listLister les produits
inspect <id>Inspecter un produit
createCréer un produit

events​

Voir les événements API.

ikw events <subcommand>
Sous-commandeDescription
listLister les événements récents
inspect <id>Inspecter un événement
ikw events list --limit 10
ikw events inspect evt_abc123

balances​

Voir les balances de compte.

ikw balances list

api-keys​

Gérer les clés API.

ikw api-keys <subcommand>
Sous-commandeDescription
listLister les clés API
createCréer une clé API
revoke <id>Révoquer une clé API

checkout​

Gérer les checkout sessions.

ikw checkout <subcommand>
Sous-commandeDescription
listLister les checkout sessions
inspect <id>Inspecter une checkout session
createCréer une checkout session

Gérer les payment links.

ikw payment-links <subcommand>
Sous-commandeDescription
listLister les payment links
inspect <id>Inspecter un payment link
createCréer un payment link

radar​

Détection de fraude Radar.

ikw radar <subcommand>
Sous-commandeDescription
rules listLister les règles de fraude
rules inspect <id>Inspecter une règle
reviews listLister les dossiers de revue

reporting​

Rapports et exports.

ikw reporting <subcommand>
Sous-commandeDescription
runs listLister les exécutions de rapports
runs createCréer une exécution de rapport

team​

Gestion d’équipe.

ikw team <subcommand>
Sous-commandeDescription
listLister les membres de l’équipe
inviteInviter un membre de l’équipe

settings​

Paramètres marchands.

ikw settings <subcommand>
Sous-commandeDescription
getObtenir les paramètres courants
updateMettre à jour les paramètres

compliance​

Compliance et KYC.

ikw compliance <subcommand>
Sous-commandeDescription
statusVoir le statut de conformité
uploadEnvoyer des documents de conformité

health​

Vérifications de santé plateforme.

ikw health check

Retourne le statut de santé de l’API Ikawaari.


inspect​

Inspecter en profondeur n’importe quelle ressource par ID.

ikw inspect <resource_type> <id>

replay​

Rejouer des événements webhook.

ikw replay <event_id>

listen​

Relayer les événements webhook sandbox Ikawaari vers un endpoint local.

ikw listen --forward-to http://localhost:4242/webhooks
FlagRequisDescription
--forward-to <url>✅URL locale recevant les événements relayés
--events <csv>Filtrer les types d’événements
--environment <environment>Environnement, sandbox par défaut
--timeout <seconds>Durée de la session de relais
--allow-non-local-forward-toAutoriser une URL non locale explicitement

trigger​

Créer un événement de test sandbox et le livrer aux endpoints webhooks et aux sessions ikw listen actives.

ikw trigger webhook.ping
ikw trigger payment_intent.succeeded --data '{"amount":5000,"currency":"XOF"}'
FlagDescription
--data <json>Surcharges JSON du payload
--mode <mode>scenario ou synthetic

test-mode​

Basculer le mode test.

ikw test-mode status
ikw test-mode enable
ikw test-mode disable

dashboard​

Ouvrir le dashboard dans votre navigateur.

ikw dashboard open

exports​

Exporter des données.

ikw exports <subcommand>
Sous-commandeDescription
paymentsExporter les données de paiements
customersExporter les données clients

connect​

Comptes connectés.

ikw connect <subcommand>

issuing​

Émission de cartes.

ikw issuing <subcommand>

tax​

Gestion des taxes.

ikw tax <subcommand>

identity​

Vérification d’identité.

ikw identity <subcommand>

climate​

Estimations climat / carbone.

ikw climate <subcommand>

marketplace​

Fonctionnalités marketplace.

ikw marketplace <subcommand>

financial-connections​

Connexions financières.

ikw financial-connections <subcommand>

accounts​

Gestion de compte.

ikw accounts <subcommand>