SDKs & Libraries

Official Ikawaari client libraries for popular programming languages.

URL packages de production

Le lien du portail packages affiché dans cette documentation est injecté au build via la variable d’environnement `IKAWAARI_PACKAGES_PROD_URL`.

Aucune URL n’est configurée dans cet environnement de build.

Official SDKs

Language	Package	Install
Node.js	@ikawaari/sdk	npm install @ikawaari/sdk

Quick Example

Node.js

import Ikawaari from '@ikawaari/sdk';

const ik = new Ikawaari({ apiKey: 'ik_test_your_key' });

const payment = await ik.payments.create({
  amount: 5000,
  currency: 'XOF',
  transaction_country: 'SN',
});

REST API

CLI public

Le CLI développeur officiel est publié sous @ikawaari/ikw :

npm install -g @ikawaari/ikw
ikw --help

Pour l’utiliser sans installation globale :

npx @ikawaari/ikw --help

Voir CLI Ikawaari et Versions et mise à jour CLI.

REST API

You can also use the API directly with any HTTP client:

curl -X POST https://api.ikawaari.com/api/v1/payment-intents \
  -H "Authorization: Bearer ik_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{"amount": 5000, "currency": "XOF", "transaction_country": "SN"}'

Merchant SDK examples

Use a merchant-scoped token when calling the merchant dashboard surface.

import Ikawaari from '@ikawaari/sdk';

const ik = new Ikawaari({
  baseUrl: 'https://api.ikawaari.com',
  merchantToken: 'merchant_jwt_here',
});

const payments = await ik.merchant.payments.list({
  status: 'succeeded',
  limit: 20,
  from: '2026-03-01',
  to: '2026-03-31',
});

const analytics = await ik.merchant.payments.analytics({
  from: '2026-03-01',
  to: '2026-03-31',
});

const refunds = await ik.merchant.payments.listRefunds('pay_123');

import Ikawaari from '@ikawaari/sdk';

const ik = new Ikawaari({
  baseUrl: 'https://api.ikawaari.com',
  merchantToken: 'merchant_jwt_here',
});

const invoice = await ik.merchant.invoices.create({
  customerId: 'cus_123',
  amount: 12500,
  currency: 'XOF',
  description: 'March subscription invoice',
  dueDate: '2026-03-31',
});

await ik.merchant.invoices.updateStatus(invoice.id, {
  status: 'paid',
});

import Ikawaari from '@ikawaari/sdk';

const ik = new Ikawaari({
  baseUrl: 'https://api.ikawaari.com',
  merchantToken: 'merchant_jwt_here',
});

const summary = await ik.merchant.dashboard.summary();
const today = await ik.merchant.dashboard.today();
const overview = await ik.merchant.dashboard.overview({
  period: '30d',
  granularity: 'day',
  compare: 'previous',
});

console.log(summary.successRate, today.balance.available, overview.topCustomers);

import Ikawaari from '@ikawaari/sdk';

const ik = new Ikawaari({
  baseUrl: 'https://api.ikawaari.com',
  merchantToken: 'merchant_jwt_here',
});

const transactions = await ik.merchant.transactions.list({
  type: 'payment',
  status: 'succeeded',
  limit: 25,
});

const stats = await ik.merchant.transactions.stats({
  type: 'payment',
  from: '2026-03-01',
  to: '2026-03-31',
});

for await (const tx of transactions) {
  console.log(tx.id, tx.amount, tx.status);
}

console.log(stats);

Langages supplémentaires

Les SDK Python, PHP, Java et .NET sont prévus. Les instructions d’installation seront publiées après vérification de la propriété des packages, de leur provenance et de leur compatibilité. Un package portant un nom similaire ne doit pas être considéré comme officiel sans cette vérification.