Skip to main content
GET
Get your balance

Authorizations

Authorization
string
header
required

Your secret API key: fc_test_… in test mode, fc_live_… in live mode.

Response

Successful Response

available
string
required

Spendable, in naira, as a decimal string.

held
string
required

Deposits our payments partner is holding for review (over its limit); not spendable yet.

low_balance_threshold
string | null
required

Below this, a charge sends balance.low. Set on the Billing page.

funding_account
V1FundingAccount · object | null
required

Your own account number, once it's active (test mode: a fake one). null until then.

object
string
default:balance
Allowed value: "balance"
currency
string
default:NGN
Allowed value: "NGN"