POST /account/api/get_account_balance

Retrieve the current balance of a specific account by account number. Returns the live settled balance directly from the core banking system.

Use this endpoint to fetch the real-time balance of any account that belongs to your business. The balance reflects settled transactions at the time of the request. You can use this endpoint to poll balances for reconciliation workflows or to display live balances in your application.

Endpoint

POST https://baasapi.payrepmfb.com/api/v1/account/api/get_account_balance

Sandbox

POST https://shogun-dev.xchangeboxng.com/api/v1/account/api/get_account_balance

Authentication

Include your Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Obtain a token from Generate Token.

Request body

account_number · string · required

The 10-digit account number to query. The account must belong to your business. Maximum 10 characters.

Example request

curl --request POST \
  --url https://baasapi.payrepmfb.com/api/v1/account/api/get_account_balance \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "account_number": "7801234567"
  }'

Response

Success

status · boolean

true when the request succeeds.

response_code · string

"00" on success.

message · string

Human-readable result message.

data · object

The account details including the current balance.

Show data fields

account_number · string

The queried account number.

account_name · string

The name registered to the account.

account_type · string

The account class: "pool", "current", or "virtual".

status · string

Current account status.

balance · string

Live balance in NGN as a decimal string, for example "250000.000000000".

last_balance_update · string | null

ISO 8601 timestamp of the most recent balance change, or null if no transactions have occurred.

{
  "status": true,
  "response_code": "00",
  "message": "Success",
  "data": {
    "account_number": "7801234567",
    "account_name": "Lagos Branch Sales",
    "account_type": "current",
    "status": "active",
    "balance": "250000.000000000",
    "last_balance_update": "2026-02-25T12:00:00Z"
  }
}

Error codes

Code	Meaning
00	Success
41	Customer not found — your API credentials are invalid
80	Service unavailable — the core banking provider is temporarily down
83	Provider error — the balance query was rejected by the core banking system