Skip to main content
Use this endpoint to fetch the current balance of a specific account. The balance you receive reflects the true live settled balance at the time of the request.

Endpoint

POST /api/v1/account/web/get_account_balance

Authentication

Include your JWT access token in the Authorization header.
Authorization: Bearer <access_token>
Obtain a token via POST /auth/web/login.

Request body

account_number
string
required
The 10-digit account number whose balance you want to retrieve.

Example request

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

Response

A successful request returns the account with its current balance.
status
boolean
true when the request succeeds.
response_code
string
"00" on success.
data
object
The account object with balance information.
{
  "status": true,
  "response_code": "00",
  "message": "Balance fetched successfully",
  "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

Response codeMeaning
41Customer not found — your session credentials are invalid.
44Account not found — no account matches the provided account number.
80Service unavailable — the core banking provider is temporarily down.