Skip to content

Partner APIs

Partner APIs provide server-to-server access for airtime purchase, data package purchase, voucher issuance, and transaction callbacks.

Scope

A partner is an approved organization with API access to ODM services. Partner administrators manage credentials in the partner portal. Partner systems submit authenticated backend requests and receive synchronous responses, with callbacks for asynchronous outcomes.

Key Capabilities

  • List active data package offers, voucher denominations, eligible merchants, and promos.
  • Submit airtime and data package purchases.
  • Issue vouchers for merchant redemption.
  • Receive callbacks for completed and failed transactions.

API Surface

MethodPathPurpose
GET/data-packagesList active data package offers.
GET/gift-denominationsList active voucher denominations.
GET/merchantsList eligible merchants.
GET/promosList active and scheduled promos.
POST/airtime/purchasePurchase airtime for a recipient.
POST/data-packages/purchaseActivate a data package for a recipient.
POST/vouchers/issueIssue a voucher for redemption.

Authentication

All partner endpoints require these headers:

  • X-API-Key
  • X-Timestamp
  • X-Signature

Partner write endpoints also require Idempotency-Key.

During API access creation, the portal generates an Ed25519 keypair. The platform stores the public key, and the private key is shown once.

Next Steps