get https://bbps-sb.payu.in/payu-nbc/v2/nbc/getOperatorList
The Get Operator List API gets all the available operators related to mobile prepaid recharge with basic information. There is no change in this API from v1 other than the endpoint.
Environment
| Test Environment | https://bbps-sb.payu.in . |
| Production Environment | Contact your Account Manager to get access to the production environment |
Note:
This API requires an access token using the Get Token API with the scope as read_operators. For more information, refer to Get Token API - BBPS.
Sample request
curl --location -g --request GET ' https:///payu-nbc/v2/nbc/getOperatorList' \
--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: - operatorCode: Contains the code of the operator. - operatorName: Contains the name of the operator - fixedBill: Contains the flag whether the bill is fixed (True) or not fixed (False) |
| Failure Scenario | |
| refId | For failure scenarios, this parameter contains the reference ID. |
| type | This field contains the value as operator_list 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 operator_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":{
"operatorsInfo":[
{
"operatorCode":"<operator_code_1>",
"operatorName":"<operator_name_1>",
"fixedBill":"<True/False>"
}{
"operatorCode":"<operator_code_2>",
"operatorName":"<operator_name_2>",
"fixedBill":"<True/False>"
}
]
}
}
Failure scenario
{
"code":600,
"status":"FAILURE",
"payload":{
"errors":[
{
"reason":"<error Message>",
"errorCode":"<Error Code>"
}
],
"refId":null,
"type":"operator_list",
"message":"operator_fetch_request_failed",
"additionalParams":{
"Key1":"value1",
"Key2":"value2",
"Key3":"value3"
}
}
}