Skip to main content
Use this endpoint to retrieve the full details of a single account. You can look up an account by its account_number or narrow the query further using optional filters such as account_type, account_class, or status. The response includes the account’s current balance, status, and the customer it belongs to.

Endpoint

POST /api/v1/account/web/get_account

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
The 10-digit account number to retrieve. Maximum 10 characters.
account_type
string
Filter by account type. Allowed values: normal, virtual, current, savings.
account_class
string
Filter by account class. Allowed values: primary, secondary.
status
string
Filter by account status. Allowed values: active, inactive, blocked, closed, pending.

Example request

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

Response

A successful request returns the matching account object.
status
boolean
true when the request succeeds.
response_code
string
"00" on success.
data
object
The account detail object.
{
  "status": true,
  "response_code": "00",
  "message": "Account fetched successfully",
  "data": {
    "account_number": "7801234567",
    "account_name": "Lagos Branch Sales",
    "account_type": "current",
    "account_class": "secondary",
    "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 parameters.