Get Biller Merchants

Overview

Description: This endpoint retrieves a list of biller merchants with their details and pagination support

Endpoint: {base_url}/merchants

REQUEST PARAMETERS

#	Parameter	Type	Description	Required?
1	categoryId	String	ID of category	Yes
2	subCategoryId	String	ID of sub category. Leave empty to get all subcategories	No
3	merchantId	String	ID of merchant if specific merchant details are required	No
4	page	Integer	Page number	No
5	size	Integer	Page size of returned records. Number of records to be returned on a page	No

Sample Requests

https://{base_url}/merchants?categoryId=67890007
https://{base_url}/merchants?categoryId=67890007&subCategoryId=283628836&page=2

RESPONSE PARAMETER

#	Parameter	Type	Description	Mandatory
1	billerMerchants	Array of Objects	List of biller merchants	Yes
2	categoryid	Integer	Category ID associated with the merchant	Yes
3	description	String	Description of the merchant	No
4	isdeleted	Boolean	Indicates if the merchant is deleted	Yes
5	merchantid	String	Unique identifier for the merchant	Yes
6	merchantname	String	Name of the merchant	Yes
7	status	String	Status of the merchant (e.g., APPROVED)	Yes
8	subcategoryid	Integer	Subcategory ID associated with the merchant	No
9	count	Integer	Number of merchants returned	Yes
10	error	String	Error message if applicable	No
11	execTime	String	Execution time of the request	No
12	hasnext	Boolean	Indicates if there is a next page	Yes
13	hasprevious	Boolean	Indicates if there is a previous page	Yes
14	islast	Boolean	Indicates if this is the last page	Yes
15	limit	Integer	Maximum number of items per request	Yes
16	message	String	Additional message about the response	No
17	offset	Integer	Offset value for pagination	Yes
18	status	Integer	Status code of the response	Yes
19	total	Integer	Total number of merchants available	Yes

GET / https://{base_url}/merchants

{
  "billerMerchants": [
    {
      "categoryid": 0,
      "description": "string",
      "isdeleted": true,
      "merchantid": "string",
      "merchantname": "string",
      "status": "APPROVED",
      "subcategoryid": 0
    }
  ],
  "count": 0,
  "error": "string",
  "execTime": "string",
  "hasnext": true,
  "hasprevious": true,
  "islast": true,
  "limit": 0,
  "message": "string",
  "offset": 0,
  "status": 0,
  "total": 0
}