Retrieve NIBSS Collection Batches

Overview

Retrieves a paginated list of collection batches with optional filtering by batch ID and date range.

Command Details

• Command: RetrieveNibssCollectionBatchesQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
pageNumber	int	No	Page number for pagination (default: 1)
pageSize	int	No	Number of records per page (default: 10)
batchId	long	No	Filter by a specific batch ID
startDate	string	No	Filter batches created from this date (ISO 8601)
endDate	string	No	Filter batches created up to this date (ISO 8601)

Try It Out

POST/api/bpm/cmdRetrieveNibssCollectionBatchesQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveNibssCollectionBatchesQuery", "data": { "pageNumber": 1, "pageSize": 10, "startDate": "2026-01-01", "endDate": "2026-03-31" } }

Response Structure

{
  "response": {
    "data": [],
    "totalCount": 0,
    "pageNumber": 1,
    "pageSize": 10
  },
  "responseCode": "00",
  "responseDescription": "Success"
}

Related Operations

• Retrieve Collections — List individual collection items within a batch
• Retrieve Transactions — View transaction-level details
• Create Batch — Create a new collection batch