Retrieve NIBSS Mandate Products

Overview

The RetrieveNibssMandateProductsQuery retrieves the list of configured NIBSS mandate products. Mandate products define the terms and configuration under which mandates can be created.

Command Details

• Command: RetrieveNibssMandateProductsQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

This query takes no parameters.

Try It Out

POST/api/bpm/cmdRetrieveNibssMandateProductsQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveNibssMandateProductsQuery", "data": {} }

Response Structure

{
  "response": {
    "data": [
      {
        "productCode": "PROD-LN-001",
        "productName": "Loan Repayment",
        "description": "Direct debit for loan repayments",
        "isActive": true
      }
    ]
  },
  "responseCode": "00",
  "responseDescription": "Success"
}

YAML Configuration

Mandate products are configured in the Channel Configuration (CC config). Add entries under the mandateProducts key:

mandateProducts:
  - productCode: PROD-LN-001
    productName: Loan Repayment
    productDescription: Direct debit mandate for loan repayment collections
    isActive: true
  - productCode: PROD-INS-001
    productName: Insurance Premium
    productDescription: Recurring insurance premium collection via direct debit
    isActive: true
  - productCode: PROD-SAV-001
    productName: Savings Plan
    productDescription: Automated savings collection via NIBSS direct debit
    isActive: true

Field	Type	Required	Description
productCode	string	Yes	Unique product identifier (referenced in CreateNibssMandateCommand)
productName	string	Yes	Display name for the product
productDescription	string	No	Detailed product description
isActive	bool	No	Whether the product is available for new mandates (default: true)

info

If no products are configured in the CC config, the system falls back to the SelfServiceMandateProduct database table.

Related Operations

• Create NIBSS Mandate — Create a mandate using a product code
• Retrieve NIBSS Mandates — List mandates filtered by product