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 for your enabled product lines.
• Look up a recipient number's registered name and whether the account is active before issuing.
• Submit airtime and data package purchases.
• Issue vouchers for merchant redemption.
• Receive callbacks for completed and failed transactions.

API Surface

Method	Path	Purpose
GET	/data-packages	List active data package offers.
GET	/gift-denominations	List active voucher denominations.
GET	/merchants	List eligible merchants.
GET	/promos	List active and scheduled promos.
GET	/exchange-rate	Read the current USD → ETB exchange rate.
POST	/kyc/check	Look up a recipient's name and account status before issuing.
POST	/airtime/purchase	Purchase airtime for a recipient.
POST	/data-packages/purchase	Activate a data package for a recipient.
POST	/vouchers/issue	Issue 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

• Getting Started
• Request Authentication
• Catalog Browsing
• Airtime Topup
• Data Package Activation
• Voucher Issuance
• KYC Check
• Exchange Rate
• Callbacks