POST /account/api/fetch_customer_accounts

Retrieve all accounts belonging to your business. Filter by account type, status, or availability to narrow results and simplify reconciliation.

Use this endpoint to list every account under your business — including pool accounts, current accounts, and virtual accounts. Pass an optional filters object to narrow the result set by account type, status, or availability. Omit the request body entirely to retrieve all accounts without any filtering.

Endpoint

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

Sandbox

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

Authentication

Include your Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Obtain a token from Generate Token.

Request body

All fields are optional. Send an empty JSON object ({}) to retrieve all accounts.

filters · object

An object containing one or more filter criteria to narrow results.

Show filters fields

filters.account_type · string

Limit results to a specific account class. Accepted values: "pool", "current", "virtual".

filters.status · string

Limit results to accounts in a specific state. Accepted values: "active", "inactive", "suspended".

filters.is_available · boolean

When true, returns only accounts that are not locked by an active collection expectation. When false, returns only locked accounts.

Example request — all accounts

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

Example request — active current accounts only

curl --request POST \
  --url https://baasapi.payrepmfb.com/api/v1/account/api/fetch_customer_accounts \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "account_type": "current",
      "status": "active"
    }
  }'

Response

Success

The data field contains an array of account objects matching your filter criteria.

data · array

List of accounts belonging to your business.

Show account object fields

account_number · string

The 10-digit account number.

account_name · string

The display name of the account.

account_type · string

One of "pool", "current", or "virtual".

status · string

Current account state: "active", "inactive", or "suspended".

balance · string

Current balance in NGN as a decimal string.

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": "Accounts fetched successfully",
  "data": [
    {
      "account_number": "7801234567",
      "account_name": "Main Pool Account",
      "account_type": "pool",
      "status": "active",
      "balance": "1500000.000000000",
      "last_balance_update": "2026-02-25T10:30:00Z"
    },
    {
      "account_number": "7801234568",
      "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