The Get Circle List API gets a list of all the available circles. There is no change in this API from v1 other than the endpoint.


Production	https://bbps-sb.payu.in/payu-nbc/v1/nbc/billfetchrequest

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

Sample request

curl --location -g --request GET ' https:///payu-nbc/v2/nbc/getCircleList'  \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{access_token}}'

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: circleRefID: Contains the circle reference ID. circleName: Contains the circle name
Failure Scenario
refId	For failure scenarios, this parameter contains the reference ID.
type	This field contains the value as circle_list_info 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 circle_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":{
      "circlesInfo":[
         {
            "circleRefID":"<id_1>",
            "circleName":"<circle_name_1>"
         },
         {
            "circleRefID":"<id_2>",
            "circleName":"<circleName_2>"
         }
      ]
   }
}

Failure scenario

{
   "code":600,
   "status":"FAILURE",
   "payload":{
      "errors":[
         {
            "reason":"<error Message>",
            "errorCode":"<Error Code>"
         }
      ],
      "refId":null,
      "type":"circle_list_info",
      "message":"circle_fetch_request_failed",
      "additionalParams":{
         "Key1":"value1",
         "Key2":"value2",
         "Key3":"value3"
      }
   }
}

Request parameters

EXAMPLE QUESTIONS