The Get Prepaid Recharge PlansAPI for getting prepaid plans. It will provide all the available prepaid recharge plans available for a given agent ID, circle ID and operator ID.

<BBPSEnvironment />

📘
Note:
This API requires an access token using the Get Token API with the scope as read_plans. For more information, refer to Get Token API - BBPS.

Sample request

curl --location --request GET 'https:///payu-nbc/v2/nbc/getRechargePlans?agentId=`{agentId}`&circleId=`{circleId}`&operatorId=`{operatorId}`' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer &lt;token&gt;'

Response parameters

Field Name

Description

code

The global response code and can be any of the following:

0: If web service call failed
1: if web service call succeeded

status

The status of the API command and can be any of the following:

SUCCESS
FAILURE

payload

It will contain a list of biller categories. For more information, refer to the payload table.

payload

The payload parameter contains the values in a JSON format are described in the following table:

Field	Description
Success Scenario
circlesInfo	This field contains the following set of values for each circle in an JSON array format: planName: This field contains the plan name. price: This field contains the plan price. validity: This field contains the validity period of the plan. talkTime: This field contains the talk time for the plan. validityDescription: This field contains the validity description. packageDescription: This field contains the package description. planType: This field contains the plan type.
Failure Scenario
refId	For failure scenarios, this parameter contains the reference ID.
type	This field contains the value as mobile_plans for this API.
error	For failure scenarios, this field contains the error message in an array format.
message	This field contains the message type as mobile_fetch_request_failed for this API.
additionalParams	For failure scenarios, this field contains the additional fields related to billers in an array format. If there is no any additional info, it will be null.

Sample response

Success scenario

{
   "code":200,
   "status":"SUCCESS",
   "payload":[
      {
         "operatorName":"OPERATOR_1",
         "operatorId":"OPERATOR_ID_1",
         "circleWisePlanLists":[
            {
               "circleName":"CIRCLE_1",
               "circleId":"CIRCLE_id_1",
               "plansInfo":[
                  {
                     "planName":"&lt;plan_name_1&gt;",
                     "price":"&lt;plan_price_1&gt;",
                     "validity":"&lt;validity_1&gt;",
                     "talkTime":"&lt;talk_time_1&gt;",
                     "validityDescription":"&lt;description_1&gt;",
                     "packageDescription":"&lt;description_1&gt;",
                     "planType":"&lt;plan_type&gt;"
                  }
               ]
            }
         ]
      },
      {
         "operatorName":"OPERATOR_2",
         "operatorId":"OPERATOR_ID_2",
         "circleWisePlanLists":[
            {
               "circleName":"CIRCLE_1",
               "circleId":"CIRCLE_id_1",
               "plansInfo":[
                  {
                     "planName":"&lt;plan_name_1&gt;",
                     "price":"&lt;plan_price_1&gt;",
                     "validity":"&lt;validity_1&gt;",
                     "talkTime":"&lt;talk_time_1&gt;",
                     "validityDescription":"&lt;description_1&gt;",
                     "packageDescription":"&lt;description_1&gt;",
                     "planType":"&lt;plan_type&gt;"
                  }
               ]
            },
            {
               "circleName":"CIRCLE_2",
               "circleId":"CIRCLE_id_2",
               "plansInfo":[
                  {
                     "planName":"&lt;plan_name_1&gt;",
                     "price":"&lt;plan_price_1&gt;",
                     "validity":"&lt;validity_1&gt;",
                     "talkTime":"&lt;talk_time_1&gt;",
                     "validityDescription":"&lt;description_1&gt;",
                     "packageDescription":"&lt;description_1&gt;",
                     "planType":"&lt;plan_type&gt;"
                  }
               ]
            }
         ]
      }
   ]
}

Failure scenario

{
   "code":600,
   "status":"FAILURE",
   "payload":{
      "errors":[
         {
            "reason":"&lt;error Message&gt;",
            "errorCode":"&lt;Error Code&gt;"
         }
      ],
      "refId":null,
      "type":"mobile_plans",
      "message":"mobile_plans_fetch_failed",
      "additionalParams":{
         "Key": "value1",
         "Key2": "value2",
         "Key3": "value3"
      }
   }
}

Request parameters

EXAMPLE QUESTIONS