Bank Statement Transactions

The Bank Statement Transactions API allows you to retrieve a paginated list of transactions from uploaded bank statements for a specific bank account. Use this endpoint to review flagged transactions, filter by status, and manage compliance alerts for transaction monitoring.

API Endpoint

GET {base_url}/transactions/monitoring/account/{accountId}/rule-hits

Request Format

This endpoint accepts a GET request with the account ID as a path parameter and query parameters for filtering and pagination.

Request Headers

Authorization: Bearer {token}

Path Parameters

Parameter	Type	Required	Description
accountId	string (UUID)	Yes	Unique identifier of the bank account

Query Parameters

Parameter	Type	Required	Default	Description
Page	number	No	1	Page number (must be greater than 0)
PageSize	number	No	10	Number of items per page (1–100)
Status	string	No	—	Filter by transaction status. Accepted values: Active, Inactive

Example Request URL

GET {base_url}/transactions/monitoring/account/57e4acc2-8b73-4a86-9a4a-753e2764418a/rule-hits?Page=1&PageSize=10&Status=Active

Response Format

{
  "version": null,
  "statusCode": 200,
  "messages": ["Processed successfully"],
  "result": {
    "data": [
      {
        "transactionId": "968969",
        "accountId": "57e4acc2-8b73-4a86-9a4a-753e2764418a",
        "source": "BankStatement",
        "date": "2010-04-21T00:00:00Z",
        "description": "Bill payment",
        "amount": 327.63,
        "currency": "USD",
        "beneficiary": "",
        "transactionType": "Debit",
        "transactionStatus": "Active",
        "score": 0,
        "riskType": "High",
        "assignedUsers": [],
        "escalation": null
      }
    ],
    "page": 1,
    "pageSize": 10,
    "totalCount": 23,
    "filters": null,
    "totalPages": 3,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "message": null,
    "unreadLogsCount": 23
  }
}

Response Fields

Field	Type	Description
version	string	API version (nullable)
statusCode	number	HTTP status code
messages	string[]	Response messages
result	object	Paginated result object

Transaction Object

Field	Type	Description
transactionId	string	Unique transaction identifier
accountId	string (UUID)	Bank account identifier the transaction belongs to
source	string	Source of the transaction (see Source Values)
date	string	ISO 8601 timestamp of the transaction date
description	string	Transaction description (e.g., Bill payment, Deposit, Direct debit)
amount	number	Transaction amount
currency	string	3-letter ISO currency code (e.g., USD, SAR, AED)
beneficiary	string	Beneficiary name or identifier
transactionType	string	Type of transaction — Credit or Debit
transactionStatus	string	Current status of the transaction — Active or Inactive
score	number	Risk score assigned to the transaction
riskType	string	Risk classification (see Risk Type Values)
assignedUsers	string[]	List of users assigned to review the transaction
escalation	object	Escalation details (nullable, present when the transaction has been escalated)

Pagination Fields

Field	Type	Description
page	number	Current page number
pageSize	number	Number of items per page
totalCount	number	Total number of matching records
filters	object	Applied filters (nullable)
totalPages	number	Computed total pages (ceil(totalCount / pageSize))
hasNextPage	boolean	true if page < totalPages
hasPreviousPage	boolean	true if page > 1
message	string	Additional message (nullable)
unreadLogsCount	number	Count of unread log entries for this account

Source Values

Source	Description
BankStatement	Transaction sourced from an uploaded bank statement

Risk Type Values

Risk Type	Description
NoRisk	No risk detected
Low	Low risk
Medium	Medium risk
High	High risk
Prohibited	Transaction is prohibited

Transaction Type Values

Type	Description
Credit	Incoming funds (e.g., deposits, transfers in)
Debit	Outgoing funds (e.g., bill payments, withdrawals)

Example Usage

cURL Example

curl -X GET \
  '{base_url}/transactions/monitoring/account/57e4acc2-8b73-4a86-9a4a-753e2764418a/rule-hits?Page=1&PageSize=10&Status=Active' \
  -H 'Authorization: Bearer your_token_here'

Error Handling

Status Code	Description	Solution
400	Invalid pagination parameters	Ensure Page > 0 and PageSize is between 1 and 100
401	Unauthorized	Verify your authentication token
403	Forbidden	Check that your account has the required permissions
404	Account not found	Verify the account ID exists
500	Internal server error	Contact support with the error details

Related Resources

• Customer Details — Retrieve the full profile of a specific customer
• Add Bank Statement — Upload a bank statement for a customer
• Add User — Register an individual for transaction monitoring
• Add Company — Register a company for transaction monitoring
• Onboarding Pending — View pending onboarding customers