Retrieve NIBSS Collection Transactions

Overview

Retrieves a paginated list of collection transactions. Transactions represent the actual NIBSS direct debit operations generated when a batch is run. Results can be filtered by batch, collection, mandate, date range, and export flag.

Command Details

• Command: RetrieveNibssCollectionTransactionsQuery
• 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 transactions by batch ID
collectionId	int	No	Filter transactions by collection item ID
mandateId	int	No	Filter transactions 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/cmdRetrieveNibssCollectionTransactionsQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveNibssCollectionTransactionsQuery", "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 Collections — List collection items
• Retrieve Batches — List collection batches
• Run Batch — Execute a batch to generate transactions