Retrieve NIBSS Mandate by ID

Overview

The RetrieveNibssMandateByIdQuery retrieves the full details of a single NIBSS mandate by its ID.

Command Details

• Command: RetrieveNibssMandateByIdQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
mandateId	long	Yes	The ID of the mandate to retrieve

Try It Out

POST/api/bpm/cmdRetrieveNibssMandateByIdQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveNibssMandateByIdQuery", "data": { "mandateId": 5012 } }

Response Structure

{
  "response": {
    "id": 5012,
    "clientCode": "CLT-001",
    "productCode": "PROD-LN-001",
    "amount": 500000.00,
    "debitAmount": 50000.00,
    "numberOfInstallments": 12,
    "startDate": "2026-04-01",
    "endDate": "2027-03-31",
    "payerName": "John Doe",
    "accountNumber": "0012345678",
    "bankCode": "058",
    "status": "Active"
  },
  "responseCode": "00",
  "responseDescription": "Success"
}

Related Operations

• Retrieve NIBSS Mandates — Search and list mandates
• Update NIBSS Mandate — Modify a mandate in Draft status
• Refresh NIBSS Mandate Status — Sync status from NIBSS