Skip to main content
GET
Retrieve an account's balance

Authorizations

Authorization
string
header
required

Authorization: Bearer <key>. Sandbox keys start with mgw_test_ and live keys start with mgw_live_. Each key works only in its own environment, and a live key works only from the IP addresses or ranges registered for it.

Path Parameters

account
string
required

One of your account codes, from GET /v1/accounts. An account code. Case-insensitive on input, and returned in uppercase.

Pattern: ^[A-Za-z0-9]{1,64}$

Response

The account's balance.

Figures are exactly as the broker reports them. opening_kobo and available_kobo can be negative when the account owes money.

object
string
required
Allowed value: "balance"
account
string
required
currency
string
required
Allowed value: "NGN"
opening_kobo
integer<int64>
required

The account's opening balance, as the broker reports it. We pass it through unchanged. Can be negative.

pending_debits_kobo
integer<int64>
required

The account's pending debits, as the broker reports them. We pass the figure through unchanged. Never negative.

available_kobo
integer<int64>
required

The account's available balance, as the broker reports it. We pass it through unchanged. Can be negative.