Biller Plans API

The Biller Plans API to fetch the plans for a biller.

Environment

Test Environmenthttps://bbps-sb.payu.in .
Production EnvironmentContact your Account Manager to get access to the production environment

📘

Note:

Send the scope of the Get Token API as read_plans to obtain the access_token for this request. For more information, refer to Get Token API - BBPS.


Sample request
curl --location -g --request POST 'https://<hostName>/payu-nbc/v1/nbc/billerPlans?agentId={AGENT_ID}&billerId={BILLER_ID}&refId={{UNIQUE_REF_ID}}&searchByTime={searchByTime}&offset={offset}&flowType={NON-BBPS/BBPS}&limi={100}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{access_token}}
Response parameters
Field NameDescription
codeThis field contains the global response code and can be any of the following:

- 0: If web service call failed
- 1: if web service call succeeded
statusThe status of the API command and can be any of the following:

- SUCCESS
- FAILURE
payloadThis parameter contains the bill fetch transaction data. Ror more information, refer to the payload table.

payload

ParameterDescription
BBPS Flow
planIdThis field contains a unique plan iD received from Biller.
billerIdThis field contains the biller identification number.
categoryThis field contains the category of plan.
subCategoryThis field contains the sub category of plan.
planDescriptionThis field contains the description of plan.
effctvFromThis field contains the plan effective from (usable as identification that plan is active to inactive).
effctvToThis field contains the plan effective to (usable as identification that plan is active to inactive).
statusThis field contains the indicator of plan status.
Non-BBPS Flow
planNameFor Non-BBBPS flow, this field contains the plan name received from biller.
priceFor Non-BBBPS flow, this field contains the price of plan.
validityFor Non-BBBPS flow, this field contains the validity of plan.
talkTimeFor Non-BBBPS flow, this field contains the talk time of plan.
validityDescriptionFor Non-BBBPS flow, this field contains the validity description of plan.
packageDescriptionFor Non-BBBPS flow, this field contains the package description of plan.
additionalParams For failure scenarios, this parameter will contain additional info.If there is not any additional info available than it will be null.  
Sample response

Success scenario

  • BBPS flow:
{
  "code": 200,
  "status": "SUCCESS",
  "payload": [
    {
      "planId": "UNIQUE_ID_FOR_PLAN",
      "billerId": "<BILLER_ID>",
      "category": "<PLAN_CATEGORY>",
      "subCategory": "<PLAN_SUB_CAT>",
      "amountInRupees": "<PLAN_Amount_In_Rupees>",
      "planDescription": "<PLAN_DESC>",
      "effctvFrom": "yyyy-MM-dd",
      "effctvTo": "yyyy-MM-dd",
      "status": "ACTIVE/DEACTIVATED",
      "additionalInfo": {
        "<KEY1>": "<VALUE1>",
        "<KEY2>": "<VALUE2>",
        "<KEY3>": "<VALUE3>",
        "<KEY4>": "<VALUE4>",
        "<KEY5>": "<VALUE5>"
      }
    }
  ]
}

  • For non-BBPS flow:
{
  "code": 200,
  "status": "SUCCESS",
  "payload": [
    {
      "planName": "ALPHANUMERIC",
      "price": "254.9",
      "validity": "20 days",
      "talkTime": "ALPHANUMERIC",
      "validityDescription": "ALPHANUMERIC",
      "packageDescription": "ALPHANUMERIC"
    }
  ]
}

Failure scenario

{
  "code": 600,
  "status": "Failure",
  "payload": null,
  "errors": [
    {
      "reason": "<error Message>",
      "errorCode": "<Error Code>"
    }
  ],
  "refId": "<refId>",
  "type": "biller_plans",
  "message": "biller_plans_fetch_failed",
  "additionalParams": {
    "Key1": "value1",
    "Key2": "value2",
    "Key3": "value3"
  }
}
Language
Authorization
Bearer
Click Try It! to start a request and see the response here!