Get all Plan categories

API for getting plan categories for a specific biller.This api has to be invoked if planMDM requirement is mandatory for the biller, it will return the plan categories

Endpoint

Request: GET /masters/planCategories?billerId=HUNG00000NA

Request Parameters

The various parameters are explained below:

Parent Property/ElementProperty/Element NameMandatoryData TypeDescription

[ROOT] (No parent property / element)

billerId

M

Alphanumeric

Fixed Length – 14

Response Parameters

The various parameters are explained below:

Parent Property/ElementProperty/Element NameMandatoryData TypeDescription

[ROOT] (No parent property / element)

categoryRespList

M

List

List of categories

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

remarks

C

String

Json Formatted Response Example

    {
    "generalResp": { 
    "statusCode": "200",
    "status": "success",
    "message": "Categories retrieved successfully", 
    "remarks": ""
    },
    "categoryRespList": 
    [ "Music"
    ]
    }

Last updated