Get Service Parameters - /api/v20/service

Used to retrieve the description of a specific service by its serviceId.

Request Structure

Parameter	Value
Method	POST
URI	<url>/api/v20/service
URI Parameters	none
Body Parameters	request parameters
Content-Type	application/json

Request Parameters

Parameter	Description	Required
serviceId	Service code in the processing system	yes

Request Example

{
  "serviceId": "A0001"
}

Response Structure

Parameter	Description	Required
services	Array of available services and their parameters	yes
serviceId	Service code in the processing system	yes
type	Payment scheme type	yes
name	Service name	yes
group	Service group	no
fixedPayment	Fixed payment amount flag	no
country	Country of service provision	no
inputs	List of input parameters entered by the user	no
inputs[].name	System name of the input parameter	no
inputs[].required	Parameter required flag	no
inputs[].title	Hint for the user	no
inputs[].regexp	Regular expression for value validation	no
displays	List of fields that may be displayed to the user after verification	no
displays[].name / required / title / regexp	Description of the returned field	no

Response Example

{
  "result": 0,
  "resultMessage": "Success",
  "services": [
    {
      "serviceId": "A0001",
      "type": 0,
      "name": "Test Service",
      "group": "Online Games",
      "fixedPayment": false,
      "country": "International",
      "inputs": [
        {
          "name": "account",
          "required": true,
          "title": "account"
        }
      ]
    }
  ]
}