Comment on page
BBPS Master Data API
List Amount option api
API for listing Amount Breakup options such as Fixed Charges, Late Payment Fee, Tuition Fee etc. for various Billers.
ENDPOINT |
|---|
Request: GET /masters/amountOptions?billerId=FE1160007XXA63 |
Request Parameters
The various parameters are explained below
Parent Property/Element | PropAerty/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
[ROOT] (No parent property / element) | billerId | M | Alphanumeric Fixed Length – 14 | NPCI identifier of the biller |
Response Parameters
The various parameters are explained below
Parent Property/Element | PropAerty/Element Name | Mandatory | Data Type | Description |
|---|---|---|---|---|
[ROOT] (No parent property / element) | amountOptions | M | Boolean | A boolean which tells if amount breakupset is present or not |
amountOptionDAOS | amountOptionId | M | UUID | Unique ID associated with a specific Amount Breakup Set |
| amountBreakupSets | M | Array of strings | Lists all combinations of Amount Breakup Options configured by the Biller |
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 |
Json Formatted Response Example
{
"amountOptions": true, "amountOptionDAOS": [
{
"amountOptionId": "5b6e4ab4-6ae1-42cd-b7c4-0030daf77575", "amountBreakupSets": [
"BASE_BILL_AMOUNT"
]
}
],
"generalResp": { "statusCode": "200",
"status": "success",
"message": "Amount options retrieved", "remarks": ""
}
}
Last modified 5mo ago