Skip to main content

Retrieve NIBSS Mandate Batches

Overview​

The RetrieveNibssMandateBatchesQuery retrieves a paginated list of mandate batches. Batches are created when mandates are submitted in bulk using the Create Mandate List command.

Command Details​

  • Command: RetrieveNibssMandateBatchesQuery
  • Type: Query

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
pageNumberintNoPage number for pagination (default: 1)
pageSizeintNoNumber of records per page (default: 10)
startDatestringNoFilter batches created on or after this date
endDatestringNoFilter batches created on or before this date

Try It Out​

POST/api/bpm/cmdRetrieveNibssMandateBatchesQuery
Request Body

Response Structure​

{
"response": {
"data": [
{
"batchId": 301,
"createdDate": "2026-02-15T10:30:00Z",
"mandateCount": 5,
"status": "Completed"
}
],
"totalCount": 12,
"pageNumber": 1,
"pageSize": 10
},
"responseCode": "00",
"responseDescription": "Success"
}