Skip to Content
Introduction

Breeze API

The Breeze API lets resellers buy brand gift cards (Apple, Netflix, PlayStation, etc.) and run airtime, data, electricity, cable TV, and betting purchases. All routes live under a single base URL:

https://api.breezeinnovations.io/v1

There is no separate staging host — live and test traffic share the same base URL. Which environment a request runs in is determined entirely by the X-Merchant-Key / X-Merchant-Secret pair you send: every merchant is provisioned with both a live credential and a test credential, and the API resolves environment from whichever one is presented. See Environments.

Quick start

  1. Contact your account manager for your live and test API keys and onboarding.

  2. Send X-Merchant-Key and X-Merchant-Secret on every request (see Authentication) — use your test key while integrating, and your live key for real customer traffic.

  3. Complete production IP permission before go-live.

  4. Buy a brand gift card or create a purchase — see Gift cards or Airtime.

  5. If you use async create, poll status with the same client_request_id:

    GET /v1/transactions/status?client_request_id={your_client_request_id}

    See Check status.

  6. Keep enough prepaid wallet balance before purchasing.

  7. Stay within the default rate limit of 30 TPS (1,800 RPM) unless a higher quota is arranged.

  8. Provide daily report email addresses for T+1 reports.

What you can do

ActionGuide
Response field rules (all products)Errors & codes
Buy brand gift cards (Apple, Netflix, etc.)Gift cards
Buy travel eSIMseSIM
Buy airtime or dataAirtime
Pay electricityElectricity
Pay cable TV (DStv, GOtv, StarTimes)Cable TV
Fund betting walletsBetting
Bill payments overviewBill payments overview
Check outcomeAirtime Async
List purchasesAirtime Async
Prepaid wallet balanceWallet balance
Full product catalog (names and amounts)Catalog
Data bundle catalogData plans
Live vs. test keysEnvironments
Throughput guidanceRate limits

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.

Last updated on