Skip to Content
Wallet balance

Wallet balance

Returns the merchant wallet balance for the merchant tied to your API key. This is the ledger used for gift-card issue and other Breeze debits — not an MTN SIM / vending-line balance.

GET /ext/breeze/v1/wallet/balance

Merchants are enrolled as either:

billing_modeMeaning
prepaidSpend only against funded balance (credit_floor is zero or positive)
postpaidOverdraft allowed down to a configured credit_floor (negative)

Example

curl "https://staging-intelligent-70287b6a3284.herokuapp.com/ext/breeze/v1/wallet/balance" \ -H "X-Merchant-Key: mk_live_your_key_id" \ -H "X-Merchant-Secret: sk_live_your_secret"

Sample response:

{ "status": "success", "data": { "merchant_id": 42, "currency": "NGN", "balance": "125000.50", "billing_mode": "prepaid", "credit_floor": "0.00" }, "total": "125000.50" }
FieldDescription
balance / totalCurrent available ledger balance
billing_modeprepaid or postpaid
credit_floorLowest balance allowed before vends / gift issue are blocked

If no merchant wallet is enrolled, the API returns 404 (merchant wallet not enrolled). Ask your account manager to enable prepaid or postpaid wallet billing for your merchant.

Last updated on