Developer API

A REST API for agents, super agents and dealers, authenticated with the API keys you generate in your dashboard.

Authentication

Send your key on every request as a Bearer token. Keys start with ink_live_ and are shown only once when created — store them like a password.

curl https://inkoom.com/api/public/v1/balance   -H "Authorization: Bearer ink_live_xxxxxxxxxxxx"

Endpoints

GET/api/public/v1/balance

Your wallet and commission balances.

GET/api/public/v1/networks

Active networks.

GET/api/public/v1/products?network=mtn

Bundles with your tier price.

POST/api/public/v1/purchase

Buy a bundle for a recipient.

GET/api/public/v1/orders/{id_or_reference}

Check an order's status.

Placing an order

reference is your own unique string and makes the call idempotent — retrying with the same reference never charges twice.

POST /api/public/v1/purchase
Authorization: Bearer ink_live_xxxxxxxxxxxx
Content-Type: application/json

{
  "product_id": "0000-...-0000",
  "recipient": "0241234567",
  "reference": "my-order-00123"
}

Responses are JSON with success and data. Failed orders are refunded to your wallet automatically and return a reason.

Webhooks

Subscribe an HTTPS endpoint in your Reseller dashboard and we'll POST signed events for every purchase and status change. The payload carries an HMAC-SHA256 signature on the X-Inkoom-Signature header, signed with your webhook secret.

curl https://your.app/webhook/inkoom   -X POST   -H "Content-Type: application/json"   -H "X-Inkoom-Signature: t=1689...,v1=sha256_..."   -d '{"event":"order.completed","data":{...}}'

View the full API reference