Get Merchant Services

Overview

Description: This endpoint retrieves a list of available biller services with their details and configurations

Endpoint: {base_url}/services

REQUEST PARAMETERS

#	Parameter	Type	Description	Required?
1	serviceId	String	ID of services. Leave empty to get all subcategories	No
2	merchantId	String	ID of merchant	Yes
3	page	Integer	Page number	No
4	size	Integer	Page size of returned records. Number of records to be returned on a page	No

Sample Requests

https://{base_url}/merchants/services?merchantId=67890007 
https://{base_url}/merchants/services?merchantId=67890007&serviceId=283628836&page

RESPONSE PARAMETER

#	Parameter	Type	Description	Mandatory
1	billerServices	Array of Objects	List of biller service details	Yes
2	description	String	Description of the biller service	Yes
3	hasBundles	Boolean	Indicates if bundles are available for the service	Yes
4	imsserviceid	String	Unique identifier for the IMS service	Yes
5	imsservicename	String	Name of the IMS service	Yes
6	isDataReturned	Boolean	Indicates if data is returned by the service	Yes
7	maxchars	Integer	Maximum number of characters allowed for the service	Yes
8	merchantid	Integer	Merchant ID associated with the biller service	Yes
9	notifycustomer	Boolean	Indicates if the customer should be notified	Yes
10	retry	Boolean	Indicates if the transaction can be retried	Yes
11	sensitive	Boolean	Indicates if the service is sensitive	Yes
12	count	Integer	Number of services returned	Yes
13	error	String	Error message, if applicable	No
14	execTime	String	Execution time of the request	No
15	hasnext	Boolean	Indicates if there is a next page	Yes
16	hasprevious	Boolean	Indicates if there is a previous page	Yes
17	islast	Boolean	Indicates if this is the last page	Yes
18	limit	Integer	Maximum number of items per request	Yes
19	message	String	Additional message about the response	No
20	offset	Integer	Offset value for pagination	Yes
21	status	Integer	Status code of the response	Yes
22	total	Integer	Total number of biller services available	Yes

GET / https://{base_url}/services

{
  "billerServices": [
    {
      "description": "string",
      "hasBundles": true,
      "imsserviceid": "string",
      "imsservicename": "string",
      "isDataReturned": true,
      "maxchars": 0,
      "merchantid": 0,
      "notifycustomer": true,
      "retry": true,
      "sensitive": true
    }
  ],
  "count": 0,
  "error": "string",
  "execTime": "string",
  "hasnext": true,
  "hasprevious": true,
  "islast": true,
  "limit": 0,
  "message": "string",
  "offset": 0,
  "status": 0,
  "total": 0
}