SDKs & Libraries

Official Ikawaari client libraries for popular programming languages.

Production packages URL

The packages portal link shown in this documentation is injected at build time from the `IKAWAARI_PACKAGES_PROD_URL` environment variable.

No URL is configured in this build environment.

Official SDKs

Language	Package	Install
Node.js	@ikawaari/sdk	npm install @ikawaari/sdk
Python	ikawaari	pip install ikawaari
PHP	ikawaari/ikawaari-php	composer require ikawaari/ikawaari-php
Java	com.ikawaari:ikawaari-java	Maven/Gradle
C# / .NET	Ikawaari.Net	dotnet add package Ikawaari.Net

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',
  payment_method_types: ['mobile_money'],
});

Python

import ikawaari

ik = ikawaari.Client(api_key="ik_test_your_key")

payment = ik.payment_intents.create(
    amount=5000,
    currency="XOF",
    payment_method_types=["mobile_money"],
)

PHP

$ik = new \Ikawaari\IkawaariClient('ik_test_your_key');

$payment = $ik->paymentIntents->create([
    'amount' => 5000,
    'currency' => 'XOF',
    'payment_method_types' => ['mobile_money'],
]);

C#

var client = new IkawaariClient("ik_test_your_key");

var payment = await client.PaymentIntents.CreateAsync(new PaymentIntentCreateOptions
{
    Amount = 5000,
    Currency = "XOF",
    PaymentMethodTypes = new List<string> { "mobile_money" },
});

REST API

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

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

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);