Get NPS Mandates

Overview

GetNpsMandatesQuery returns a paginated list of NPS ISO 20022 mandates (MandateSetup records where sourceProvider = "nps"). This covers both outward mandates we initiated and inward mandates received from other banks.

Command Details

• Command: GetNpsMandatesQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
pageNumber	int	No	Page number (default: 1)
pageSize	int	No	Records per page (default: 20)
mandateStatus	string	No	Filter by status: Active, Pending, Cancelled, Amended
searchText	string	No	Search by mandate reference, account number, or account name
startDate	string	No	Filter by dateCreated ≥ this date (yyyy-MM-dd)
endDate	string	No	Filter by dateCreated ≤ this date (yyyy-MM-dd)
isExport	bool	No	true to export all results as Excel

Try It Out

POST/api/bpm/cmdGetNpsMandatesQuery

Base URL

Bearer Token

Request Body

{ "cmd": "GetNpsMandatesQuery", "data": { "pageNumber": 1, "pageSize": 20, "isExport": false } }

Response Structure

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "5/5 records.",
  "count": 5,
  "pages": 1,
  "size": 5,
  "hasNext": false,
  "hasPrevious": false,
  "data": [
    {
      "id": 101,
      "sessionID": "NPS-20260101-001",
      "mandateReferenceNumber": "MND0000000001",
      "debitAccountName": "JOHN DOE",
      "debitAccountNumber": "0123456789",
      "beneficiaryAccountName": "ABC COMPANY",
      "beneficiaryAccountNumber": "9876543210",
      "destinationInstitutionCode": "000014",
      "amount": 50000.00,
      "mandateStatus": "Active",
      "statusMessage": null,
      "sourceProvider": "nps",
      "dateCreated": "2026-01-15T10:30:00Z",
      "lastUpdated": "2026-01-15T10:35:00Z",
      "responseCode": "00"
    }
  ]
}

Response Fields

Field	Type	Description
id	int	Internal mandate record ID
sessionID	string	NPS session identifier
mandateReferenceNumber	string	NPS mandate reference number
debitAccountNumber	string	Account being debited
debitAccountName	string	Debtor account name
beneficiaryAccountNumber	string	Beneficiary (creditor) account
beneficiaryAccountName	string	Beneficiary account name
destinationInstitutionCode	string	Counterpart bank code. Equals our bank code for inward mandates; differs for outward
amount	decimal	Mandate collection amount
mandateStatus	string	Current status: Active, Pending, Cancelled, Amended
statusMessage	string	Status detail or cancellation reason
sourceProvider	string	Always "nps" for NPS mandates
dateCreated	datetime	When the mandate was created
lastUpdated	datetime	Last status update time
responseCode	string	NPS response code

Related Operations

• Get NPS Mandate by ID — Full detail including linked debit history
• Cancel NPS Mandate — Cancel an outward mandate
• Amend NPS Mandate — Amend amount or end date