Skip to Content
Introduction

Breeze API

The Breeze API lets resellers issue BreezeGift cards and run airtime, data, electricity, cable TV, and betting purchases. All routes live under:

/ext/breeze/v1

Base URLs differ for staging and production — see Environments.

Quick start

  1. Contact your account manager for staging credentials and onboarding. Staging base URL: https://staging-intelligent-70287b6a3284.herokuapp.com (production URL will be advised).
  2. Send X-Merchant-Key and X-Merchant-Secret on every request (see Authentication).
  3. Complete production IP permission before go-live.
  4. Issue a gift card or create a purchase — see Gift cards or Transactions.
  5. Keep enough wallet balance (prepaid or postpaid merchant wallet) before issuing or vending.
  6. Provide daily report email addresses for T+1 reports.

What you can do

ActionGuide
Issue a BreezeGift cardGift cards
Buy airtime or dataTransactions
Pay electricityElectricity
Pay cable TV (DStv, GOtv, StarTimes)Cable TV
Fund betting walletsBetting
Bill payments overviewBill payments overview
Check outcomeTransactions
List purchasesTransactions
Wallet balance (prepaid / postpaid)Wallet balance
Data bundle catalogData plans
Staging & production setupEnvironments

Networks (airtime & data)

Use lowercase network names: mtn, glo, airtel, 9mobile.

Merchant code

Transaction request bodies include merchant_code — your merchant profile. Your API credentials must belong to that merchant. Gift-card issue uses the merchant bound to your API key (no merchant_code in the body).

Last updated on
Authentication