Skip to main content
GET
Check credit balance

Authorizations

Authorization
string
header
required

Beem API credentials: API key as username, API secret as password.

Query Parameters

app_name
enum<string>
required

Product identifier. Use AIRTIME for Airtime API, USSD for USSD billing, BPAY for payments.

Available options:
AIRTIME,
USSD,
BPAY,
SMS,
OTP,
CHAT,
BROADCAST,
EMG,
MOJA
user_id

Admin only — query balance for another user

country
string

Optional ISO country code filter

currency
string

Optional ISO currency code filter

Response

Successful response

data
object
required