Balance

Read the prepaid wallet linked to the customer that owns your API key. Funds are deducted when transactions settle.

How to use

Call GET /balance with scope balance:read.
Use available for spendable funds; held is reserved for in-flight purchases.
Create purchases via POST /transactions — the wallet is charged when the transaction settles.

Scope: balance:read

GEThttps://confident-elephant-309.convex.site/v1/balance

Request

curl -sS https://confident-elephant-309.convex.site/v1/balance \  -H "Authorization: Bearer $KEY"

200 OK

{  "balance": {    "available": 94,    "currency": "GHS",    "held": 4  }}

Field	Meaning
`available`	Spendable balance in major currency units (GHS)
`held`	Amount reserved for in-flight transactions
`currency`	ISO-like code; currently GHS