Retrieve NIBSS Mandate Products

Overview

The RetrieveNibssMandateProductsQuery retrieves the loan products that can classify NIBSS GSI mandates. The data comes from loanProductConfiguration; there is no separate mandate-product configuration.

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": "PR-1",
        "productName": "Payroll",
        "productDescription": "Payroll loan repayment mandate",
        "isActive": true
      }
    ]
  },
  "responseCode": "00",
  "responseDescription": "Success"
}

YAML Configuration

Products are configured once in loanProductConfiguration. The product's code, name, and optional description are also used for its NIBSS GSI mandate classification:

loanProducts:
  - code: PR-1
    name: Payroll
    description: Payroll loan repayment mandate
    currencyCode: NGN
    # other loan settings...

Field	Type	Required	Description
code	string	Yes	Loan product code stored on the GSI mandate
name	string	Yes	Loan product and mandate classification display name
description	string	No	Product description or comments returned as productDescription

info

The loanProductConfiguration record must be enabled. The legacy mandate-product table and ChannelConfiguration.mandateProducts are not used.

Related Operations

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