Customer Parameters Groups API

API for listing Customer Parameter groups of a specific Biller, by using the Biller ID.It returns combination of customer params that customer can use

Endpoint

Request: GET /masters/customerParamGroup?billerId=DKAFEE000KER06

Request Parameters

The various parameters are explained below:

Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description

[ROOT] (No parent property / element)

billerId

M

Alphanumeric

Fixed Length – 14

Response Parameters

The various parameters are explained below:

Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description

[ROOT] (No parent property / element)

customerParamGroupR esp

groups

name

M

String

Name of the group

input

M

String

Input value of group

params

M

List

List of string containing the combination

groups

M

Object

Inner Group with same model as the outer Group

generalResp

statusCode

M

Numeric

200- SUCCESS Other than 200-Failure

status

M

String

It is either “Success” or failure

message

M

String

Contains the reason message for failure / success

Json Formatted Response Example

    {
    "generalResp": { "statusCode": "200",
    "status": "success",
    "message": "Customer param group retrieved successfully", "remarks": ""
    },
    "customerParamGroupResp": { "groups": [
    {
    "groupId": "e7a1daac-4d64-4dc0-9f4b-c07c631d5f67", "params": [
    "Admission No/Application No/GR No"
    ],
    "groups": [
    {
    "groupId": "4cde9c57-3f0c-4293-84a3-b8f3c834f23d", "params": [
    "Date Of Birth (DD-MM-YYYY)", "Mobile No"
    ],
    "groups": [],
    "name": "Group1",
    "input": "2"
    }
    ],
    "name": "Group1.1",
    "input": "1"
    }
    ]
    }
    }

Last updated