POST /transaction/web/fetch_transactions

Retrieve a paginated transaction history for your accounts via the Dashboard API. Filter by account number, date range, type, or status.

Use this endpoint to retrieve a paginated list of transactions across your accounts. You can narrow results by account number, date range, transaction direction, status, and more. This endpoint is the primary source for building transaction history views, generating statements, and automating reconciliation within the Dashboard API context.

Endpoint

POST https://baasapi.payrepmfb.com/api/v1/transaction/web/fetch_transactions

Sandbox

POST https://shogun-dev.xchangeboxng.com/api/v1/transaction/web/fetch_transactions

Authentication

Include your Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Obtain a token by logging in via User Login.

Request body

All filter criteria are nested inside a filters object. Pagination is controlled by top-level parameters.

filters · object

Optional object containing filter criteria for the transaction query.

Show filters

account_number · string

Limit results to a specific 10-digit account number.

start_date · string (date)

Return only transactions on or after this date. Format: YYYY-MM-DD.

end_date · string (date)

Return only transactions on or before this date. Format: YYYY-MM-DD.

date · string (date)

Filter to a single calendar day. Format: YYYY-MM-DD. When provided, takes precedence over start_date and end_date.

status · string

Filter by transaction status. Common values: success, pending, failed.

transaction_type · string

Filter by transaction direction. Use credit for inbound payments or debit for outbound transfers.

transaction_category · string

Filter by category such as collection or transfer.

reference_number · string

Fetch a specific transaction by its unique reference number.

channel · string

Filter by payment channel — for example, nip (interbank) or intra (intra-bank).

search · string

Free-text search across transaction fields such as narration and reference number.

page · integer · default: "1"

Page number for paginated results. Starts at 1.

page_size · integer · default: "20"

Number of transactions to return per page. Minimum 1.

limit · integer · default: "20"

Maximum number of results to return. Minimum 1.

cursor_created_at · string (date-time)

Cursor for cursor-based pagination. Pass the created_at timestamp of the last item from the previous page.

cursor_id · string (uuid)

Cursor ID paired with cursor_created_at for stable cursor-based pagination.

Example request

curl --request POST \
  --url https://baasapi.payrepmfb.com/api/v1/transaction/web/fetch_transactions \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "account_number": "7801234567",
      "start_date": "2026-04-01",
      "end_date": "2026-04-28",
      "transaction_type": "credit",
      "status": "success"
    },
    "page": 1,
    "page_size": 20
  }'

Response

A successful response returns the standard envelope with a paginated array of transaction objects in data.

status · boolean

true when the request succeeded.

response_code · string

"00" on success.

message · string

Human-readable status message.

data · array

Array of transaction objects matching your filters.

Show Transaction object

reference_number · string

Unique identifier for the transaction. Use this for reconciliation and status lookups.

account_number · string

The account number associated with this transaction.

amount · string (decimal)

Transaction amount in NGN (e.g., "5000.00").

transaction_type · string

Direction of the transaction: credit (inbound) or debit (outbound).

status · string

Current status of the transaction: success, pending, or failed.

narration · string

Description or reference text attached to the transaction.

created_at · string (date-time)

ISO 8601 timestamp of when the transaction was recorded.

{
  "status": true,
  "response_code": "00",
  "message": "Transactions fetched successfully",
  "data": [
    {
      "reference_number": "TXN-20260415-00123",
      "account_number": "7801234567",
      "amount": "50000.00",
      "transaction_type": "credit",
      "status": "success",
      "narration": "Payment for Invoice #INV-0042",
      "created_at": "2026-04-15T10:32:00Z"
    }
  ]
}

Error codes

Code	Meaning
00	Success
41	Customer not found — your session token is invalid or expired