Skip to main content
Use this endpoint to retrieve all accounts under your business alongside aggregated transaction statistics. Each account in the response includes its total inbound collection count and value, total outbound transfer count and value, and the date of the most recent transaction. You can narrow results using optional filters.

Endpoint

POST /api/v1/account/web/fetch_account_summaries

Authentication

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

Request body

All body parameters are optional. Omit the body entirely to retrieve summaries for all accounts.
account_type
string
Filter by account type. Allowed values: normal, virtual, current, savings.
account_number
string
Filter by a specific 10-digit account number.
status
string
Filter by account status. Allowed values: active, inactive, blocked, closed, pending.
is_available
boolean
Filter by account availability flag.
limit
integer
Maximum number of accounts to return per page.
cursor_created_at
string
Cursor for pagination — the created_at timestamp of the last item from the previous page (ISO 8601).
cursor_id
string
Cursor for pagination — the id of the last item from the previous page (UUID).

Example request

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

Response

A successful request returns an array of account summary objects.
status
boolean
true when the request succeeds.
response_code
string
"00" on success.
data
array
Array of account summary objects.
{
  "status": true,
  "response_code": "00",
  "message": "Account summaries fetched successfully",
  "data": [
    {
      "account_number": "7801234567",
      "account_name": "Main Pool Account",
      "account_type": "pool",
      "account_class": "primary",
      "status": "active",
      "balance": "1500000.000000000",
      "last_balance_update": "2026-02-25T10:30:00Z",
      "total_collections": 142,
      "total_collection_amount": "5200000.00",
      "total_transfers": 38,
      "total_transfer_amount": "3700000.00",
      "total_transactions": 180,
      "last_transaction_date": "2026-02-25T14:22:00Z",
      "created_at": "2026-01-15T09:00:00Z"
    }
  ]
}

Error codes

Response codeMeaning
41Customer not found — your session credentials are invalid.