Retrieve NIBSS Collections

Overview

Retrieves a paginated list of individual collection items with optional filtering by batch, mandate, date range, and export flag.

Command Details

• Command: RetrieveNibssCollectionsQuery
• 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	int	No	Filter collections by batch ID
mandateId	int	No	Filter collections by mandate ID
isExport	bool	No	Set to true to export all results (default: false)
startDate	string	No	Filter from this date (ISO 8601)
endDate	string	No	Filter up to this date (ISO 8601)

Try It Out

POST/api/bpm/cmdRetrieveNibssCollectionsQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveNibssCollectionsQuery", "data": { "pageNumber": 1, "pageSize": 10, "isExport": false, "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 Batches — List collection batches
• Retrieve Transactions — View transaction-level details
• Add Item to Batch — Add more items to a draft batch