Get Service Requirements

Overview

Description: This endpoint retrieves a list of biller service requirements for processing transactions

Endpoint: {base_url}/billit/requirements

Additional Header Parameters

#	Parameter	Value/Sample	Description
1	serviceId	21001	billerServices.imsserviceid from the response gotten from get Merchants Services

RESPONSE PARAMETER

#	Parameter	Type	Description	Mandatory
1	billerServiceRequirements	Array of Objects	List of biller service requirements	Yes
2	billerServiceRequirements.forNotification	Boolean	Indicates if the requirement is for notification	Yes
3	billerServiceRequirements.forValidation	Boolean	Indicates if the requirement is for validation	Yes
4	billerServiceRequirements.identity	Boolean	Indicates if identity information is required	Yes
5	billerServiceRequirements.imsserviceid	String	Unique identifier for the IMS service	Yes
6	billerServiceRequirements.maxchars	Integer	Maximum number of characters allowed for the requirement	Yes
7	billerServiceRequirements.merchantid	Integer	Unique identifier for the merchant	Yes
8	billerServiceRequirements.reqdatatype	String	Data type required for the service	Yes
9	billerServiceRequirements.reqdesc	String	Description of the requirement	Yes
10	billerServiceRequirements.required	Boolean	Indicates if the requirement is mandatory	Yes
11	billerServiceRequirements.requirementname	String	Name of the requirement	Yes
12	count	Integer	Number of requirements 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 service requirements available	Yes

GET / https://{base_url}/requirements

{
  "billerServiceRequirements": [
    {
      "fornotification": true,
      "forvalidation": true,
      "identity": true,
      "imsserviceid": "string",
      "maxchars": 0,
      "merchantid": 0,
      "reqdatatype": "string",
      "reqdesc": "string",
      "required": true,
      "requirementname": "string"
    }
  ],
  "count": 0,
  "error": "string",
  "execTime": "string",
  "hasnext": true,
  "hasprevious": true,
  "islast": true,
  "limit": 0,
  "message": "string",
  "offset": 0,
  "status": 0,
  "total": 0
}