Get NPS Mandate by ID

Overview

GetNpsMandateByIdQuery retrieves the full detail of a single NPS mandate including all linked inward direct debit requests collected under it.

Command Details

• Command: GetNpsMandateByIdQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
id	int	Yes	Internal ID of the mandate record

Try It Out

POST/api/bpm/cmdGetNpsMandateByIdQuery

Base URL

Bearer Token

Request Body

{ "cmd": "GetNpsMandateByIdQuery", "data": { "id": 101 } }

Response Structure

{
  "isSuccessful": true,
  "statusCode": "00",
  "data": {
    "id": 101,
    "sessionID": "NPS-20260101-001",
    "mandateReferenceNumber": "MND0000000001",
    "destinationInstitutionCode": "000014",
    "channelCode": "1",
    "debitAccountName": "JOHN DOE",
    "debitAccountNumber": "0123456789",
    "debitBankVerificationNumber": "12345678901",
    "debitKYCLevel": "3",
    "beneficiaryAccountName": "ABC COMPANY",
    "beneficiaryAccountNumber": "9876543210",
    "beneficiaryBankVerificationNumber": "98765432101",
    "beneficiaryKYCLevel": "3",
    "amount": 50000.00,
    "mandateStatus": "Active",
    "statusMessage": null,
    "sourceProvider": "nps",
    "responseCode": "00",
    "dateCreated": "2026-01-15T10:30:00Z",
    "lastUpdated": "2026-01-15T10:35:00Z",
    "linkedDebitRequests": [
      {
        "id": 501,
        "sessionID": "SESS-20260201-001",
        "amount": 50000.00,
        "status": "Successful",
        "responseCode": "00",
        "responseDescription": "Approved",
        "transactionTimeStamp": "2026-02-01T08:00:00Z",
        "transactionId": "TXN123456",
        "sourceProvider": "nps"
      }
    ],
    "totalDebits": 1
  }
}

Response Fields

Field	Type	Description
mandateReferenceNumber	string	NPS mandate reference
destinationInstitutionCode	string	Counterpart bank code
channelCode	string	NPS channel code
debitBankVerificationNumber	string	Debtor BVN
debitKYCLevel	string	Debtor KYC tier
beneficiaryBankVerificationNumber	string	Beneficiary BVN
beneficiaryKYCLevel	string	Beneficiary KYC tier
linkedDebitRequests	array	All pacs.003 debit collections under this mandate
totalDebits	int	Count of linked debit requests

Related Operations

• Get NPS Mandates — Search and list mandates
• Cancel NPS Mandate — Cancel this mandate
• Amend NPS Mandate — Modify amount or end date