Retrieve NIBSS Mandates

Overview

The RetrieveNibssMandatesQuery retrieves a paginated list of NIBSS mandates with optional filtering by batch, mandate ID, and date range.

Command Details

• Command: RetrieveNibssMandatesQuery
• 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 by batch ID
mandateId	int	No	Filter by specific mandate ID
isExport	bool	No	Whether to export results (default: false)
startDate	string	No	Filter mandates created on or after this date
endDate	string	No	Filter mandates created on or before this date

Try It Out

POST/api/bpm/cmdRetrieveNibssMandatesQuery

Base URL

Bearer Token

Request Body

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

Response Structure

{
  "response": {
    "data": [
      {
        "id": 5012,
        "clientCode": "CLT-001",
        "payerName": "John Doe",
        "amount": 500000.00,
        "status": "Active",
        "startDate": "2026-04-01",
        "endDate": "2027-03-31"
      }
    ],
    "totalCount": 45,
    "pageNumber": 1,
    "pageSize": 10
  },
  "responseCode": "00",
  "responseDescription": "Success"
}

Related Operations

• Retrieve NIBSS Mandate by ID — Get details for a specific mandate
• Retrieve NIBSS Mandate Batches — List mandate batches
• Create NIBSS Mandate — Create a new mandate