# Categories Master Data API

**API for listing all Biller Categories in the BBPS application.**

| Endpoint                                                                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------- |
| **Request:&#x20;**<mark style="color:blue;">**GET https\://\<master\_server\_url>/agent/cou-master/masters/categories-master**</mark> |

<mark style="color:blue;">**Request Parameters**</mark>

**The various parameters are explained below:**

| Parent Property/Element                    | Property/Element Name | Mandatory | Data Type | Description              |
| ------------------------------------------ | --------------------- | --------- | --------- | ------------------------ |
| **\[ROOT]** (No parent property / element) | category              | C         | String    | Name of the category     |
| **\[ROOT]** (No parent property / element) | tenantId              | M         | String    | Tenant ID of the OU/Bank |

<mark style="color:blue;">**Response Parameters**</mark>

**The various parameters are explained below:**

| Parent Property/Element                    | Property/Element Name | Mandatory | Data Type             | Description                                   |
| ------------------------------------------ | --------------------- | --------- | --------------------- | --------------------------------------------- |
| **\[ROOT]** (No parent property / element) | categoryRespList      | M         | Array of categoryresp | List of category masters                      |
| **categoryRespListA**                      | categoryId            | M         | UUID                  | Unique ID associated with a specific category |
|                                            | categoryName          | M         | String                |                                               |
|                                            | categoryIcon          | M         | String                |                                               |
|                                            | categoryDomain        | M         | String                |                                               |
|                                            | buttonName            | M         | String                |                                               |
|                                            | textArea              | M         | String                |                                               |
|                                            | faqDetailsList        | M         | Array of FAQ          |                                               |
| **faqDetailsList**                         | name                  | C         | String                |                                               |
|                                            | value                 | C         | String                |                                               |
| **generalResp**                            | statusCode            | M         | Numeric               |                                               |
|                                            | status                | M         | String                |                                               |
|                                            | message               | M         | String                |                                               |

<mark style="color:blue;">**Json Formatted Response Example**</mark>

```json
    {
    "generalResp": { "statusCode": "200",
    "status": "success",
    "message": "Categories retrieved successfully", 
    "remarks": ""
    },
    "categoryRespList": [
    {
    "categoryId": "a00957d8-67e5-456a-ae55-fa3ef420fc3b", 
    "categoryName": "Insurance",
    "categoryIcon": "data:image/png;base64,", 
    "categoryDomain": "Insurance", 
    "buttonName": "Insurance",
    "textArea": "dGVzdA==", 
    "faqDetailsList": [
    {
    "name": "test",
    "value": "test"
    }
    ]
    },
    {
    "categoryId": "725c74e2-c68e-4269-9bb3-4eff5ac861a2", 
    "categoryName": "Broadband Postpaid",
    "categoryIcon": "data:image/png;base64,", 
    "categoryDomain": "Utilities", 
    "buttonName": "Broadband Postpaid", 
    "textArea": "dGVzdA==",
    "faqDetailsList": [
    {
    "name": "test",
    "value": "test"
    }
    ]
    },
    {
    "categoryId": "e03adf60-7c1e-47a9-b4c5-31ded125af6f", 
    "categoryName": "Landline Postpaid",
    "categoryIcon": "data:image/png;base64,", 
    "categoryDomain": "Utilities", 
    "buttonName": "Landline Postpaid", 
    "textArea": "dGVzdA==",
    "faqDetailsList": [
    {
    "name": "test",
    "value": "test"
    }
    ]
    }
    ]
    }
```