Retrieve Deposit Transaction List

Overview

The RetrieveDepositTransactionListQuery allows you to retrieve a paginated list of transactions for deposit accounts with filtering and sorting options.

API Endpoint

POST /api/bpm/cmd

Headers

Content-Type: application/json
Authorization: Bearer {access_token}
X-Tenant-ID: {tenant_id}

Request Structure

{
  "cmd": "RetrieveDepositTransactionListQuery",
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "searchText": "string",
    "id": "integer",
    "status": [0, 1],
    "startDate": "2024-01-01",
    "endDate": "2024-12-31",
    "isExport": false
  }
}

Request Fields

Field	Type	Required	Description	Default
pageNumber	integer	No	Page number to retrieve	1
pageSize	integer	No	Number of records per page	10
searchText	string	No	Search text to filter transactions	-
id	integer	No	Specific transaction ID to retrieve	-
status	array	No	Array of status codes to filter by	-
startDate	string	No	Start date for date range filter (YYYY-MM-DD)	-
endDate	string	No	End date for date range filter (YYYY-MM-DD)	-
isExport	boolean	No	Whether to export all data (ignores pagination)	false

Status Codes

Common transaction status codes:

• 0 - Pending
• 1 - Approved/Completed
• 2 - Rejected
• 3 - Cancelled

Sample Request

{
  "cmd": "RetrieveDepositTransactionListQuery",
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "startDate": "2024-01-01",
    "endDate": "2024-12-31",
    "status": [1],
    "searchText": "John"
  }
}

Response Structure

Success Response

{
  "isSuccessful": true,
  "message": "Transaction list retrieved successfully",
  "statusCode": "00",
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalCount": 145,
    "totalPages": 3,
    "items": [
      {
        "id": 12345,
        "accountNumber": "1234567890",
        "accountName": "John Doe Savings",
        "transactionType": "Credit",
        "amount": 50000.00,
        "balanceAfter": 300000.00,
        "transactionDate": "2024-03-10T14:20:00Z",
        "valueDate": "2024-03-10",
        "description": "Cash deposit",
        "reference": "REF20240310001",
        "channelName": "Branch",
        "status": 1,
        "createdBy": "teller@bank.com",
        "createdDate": "2024-03-10T14:20:00Z"
      }
    ]
  }
}

Error Response

{
  "isSuccessful": false,
  "message": "Invalid date range provided",
  "statusCode": "99",
  "data": null
}

Use Cases

1. Retrieve Recent Transactions

{
  "cmd": "RetrieveDepositTransactionListQuery",
  "data": {
    "pageNumber": 1,
    "pageSize": 20,
    "startDate": "2024-12-01",
    "endDate": "2024-12-31"
  }
}

2. Search for Specific Transaction

{
  "cmd": "RetrieveDepositTransactionListQuery",
  "data": {
    "id": 12345
  }
}

3. Export All Transactions

{
  "cmd": "RetrieveDepositTransactionListQuery",
  "data": {
    "isExport": true,
    "startDate": "2024-01-01",
    "endDate": "2024-12-31"
  }
}

4. Filter by Status

{
  "cmd": "RetrieveDepositTransactionListQuery",
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "status": [1],
    "searchText": "deposit"
  }
}

Notes

• When isExport is set to true, pagination is ignored and all matching records are returned
• Date filters use the CreatedDate field of the transaction
• The startDate filter includes transactions from the beginning of that day (00:00:00)
• The endDate filter includes transactions up to the end of that day (23:59:59)
• Search text filters across multiple fields including account number, account name, description, and reference
• The data object can include additional predicate filters using the DynamicPredicateBuilder

Related Commands

• Initiate Deposit - Create a new deposit transaction
• Initiate Withdrawal - Create a withdrawal transaction
• Retrieve Deposit List - Get list of deposit accounts
• Retrieve Deposit By ID - Get specific deposit account details