Command Reference
Complete reference for all ikw CLI commands. Every command supports the global flags (--json, --dry-run, --debug, --trace, --request-id, --idempotency-key).
payments
Manage PaymentIntents.
ikw payments <subcommand>
| Subcommand | Description |
|---|---|
list | List payment intents |
inspect <id> | Inspect a payment intent |
create | Create a payment intent |
confirm <id> | Confirm a payment intent |
cancel <id> | Cancel a payment intent |
refund <id> | Refund a payment |
refunds <id> | List refunds for a payment |
payments create
ikw payments create \
--amount 5000 \
--currency XOF \
--description "Order #123" \
--customer cus_abc123 \
--metadata '{"order_id": "123"}'
| Flag | Required | Description |
|---|---|---|
--amount <n> | ✅ | Amount in smallest currency unit |
--currency <code> | ✅ | Currency code (e.g., XOF) |
--description <text> | Payment description | |
--metadata <json> | JSON metadata object | |
--customer <id> | Customer ID | |
--customer-email <email> | Customer email | |
--customer-phone <phone> | Customer phone |
payments confirm
ikw payments confirm pi_abc123 \
--type mobile_money \
--mm-country CI \
--mm-operator orange_ci \
--mm-msisdn +2250700000001
| Flag | Required | Description |
|---|---|---|
--type <type> | ✅ | mobile_money or card |
--mm-country <code> | Mobile money country | |
--mm-operator <code> | Mobile money operator | |
--mm-msisdn <phone> | Mobile money phone number | |
--card-token <token> | Card token | |
--return-url <url> | Return URL for 3DS |
payments refund
ikw payments refund pi_abc123 --amount 2500 --reason "Customer request"
| Flag | Description |
|---|---|
--amount <n> | Partial refund amount (default: full) |
--reason <text> | Refund reason |
customers
Manage customers.
ikw customers <subcommand>
| Subcommand | Description |
|---|---|
list | List customers |
inspect <id> | Inspect a customer |
create | Create a customer |
update <id> | Update a customer |
delete <id> | Delete a customer |
customers create
ikw customers create \
--name "Aminata Koné" \
--email aminata@example.com \
--phone +2250700000000
payouts
Manage payouts.
ikw payouts <subcommand>
| Subcommand | Description |
|---|---|
list | List payouts |
inspect <id> | Inspect a payout |
create | Create a payout |
cancel <id> | Cancel a payout |
payouts create
ikw payouts create \
--amount 50000 \
--currency XOF \
--type mobile_money \
--phone +2250700000000 \
--operator orange_ci
invoices
Manage invoices.
ikw invoices <subcommand>
| Subcommand | Description |
|---|---|
list | List invoices |
inspect <id> | Inspect an invoice |
create | Create an invoice |
finalize <id> | Finalize a draft invoice |
void <id> | Void an invoice |
subscriptions
Manage subscriptions.
ikw subscriptions <subcommand>
| Subcommand | Description |
|---|---|
list | List subscriptions |
inspect <id> | Inspect a subscription |
create | Create a subscription |
cancel <id> | Cancel a subscription |
products
Manage products and prices.
ikw products <subcommand>
| Subcommand | Description |
|---|---|
list | List products |
inspect <id> | Inspect a product |
create | Create a product |
events
View API events.
ikw events <subcommand>
| Subcommand | Description |
|---|---|
list | List recent events |
inspect <id> | Inspect an event |
ikw events list --limit 10
ikw events inspect evt_abc123
balances
View account balances.
ikw balances list
api-keys
Manage API keys.
ikw api-keys <subcommand>
| Subcommand | Description |
|---|---|
list | List API keys |
create | Create an API key |
revoke <id> | Revoke an API key |
checkout
Manage checkout sessions.
ikw checkout <subcommand>
| Subcommand | Description |
|---|---|
list | List checkout sessions |
inspect <id> | Inspect a checkout session |
create | Create a checkout session |
payment-links
Manage payment links.
ikw payment-links <subcommand>
| Subcommand | Description |
|---|---|
list | List payment links |
inspect <id> | Inspect a payment link |
create | Create a payment link |
radar
Radar fraud detection.
ikw radar <subcommand>
| Subcommand | Description |
|---|---|
rules list | List fraud rules |
rules inspect <id> | Inspect a rule |
reviews list | List review cases |
reporting
Reports and exports.
ikw reporting <subcommand>
| Subcommand | Description |
|---|---|
runs list | List report runs |
runs create | Create a report run |
team
Team management.
ikw team <subcommand>
| Subcommand | Description |
|---|---|
list | List team members |
invite | Invite a team member |
settings
Merchant settings.
ikw settings <subcommand>
| Subcommand | Description |
|---|---|
get | Get current settings |
update | Update settings |
compliance
Compliance and KYC.
ikw compliance <subcommand>
| Subcommand | Description |
|---|---|
status | View compliance status |
upload | Upload compliance documents |
health
Platform health checks.
ikw health check
Returns the health status of the Ikawaari API.
inspect
Deep inspect any resource by ID.
ikw inspect <resource_type> <id>
replay
Replay webhook events.
ikw replay <event_id>
test-mode
Toggle test mode.
ikw test-mode status
ikw test-mode enable
ikw test-mode disable
dashboard
Open the dashboard in your browser.
ikw dashboard open
exports
Export data.
ikw exports <subcommand>
| Subcommand | Description |
|---|---|
payments | Export payments data |
customers | Export customers data |
connect
Connected accounts.
ikw connect <subcommand>
issuing
Card issuing.
ikw issuing <subcommand>
tax
Tax management.
ikw tax <subcommand>
identity
Identity verification.
ikw identity <subcommand>
climate
Climate / carbon estimates.
ikw climate <subcommand>
marketplace
Marketplace features.
ikw marketplace <subcommand>
financial-connections
Financial connections.
ikw financial-connections <subcommand>
accounts
Account management.
ikw accounts <subcommand>