Skip to main content

Get Service List - /api/v20/services

Returns the list of services available to the Agent, including their type, input fields, validation rules, and possible display fields.

Request Structure

ParameterValue
MethodPOST
URI<url>/api/v20/services
URI Parametersnone
Body Parametersnone
Content-Typeapplication/json

Response Structure

ParameterDescriptionRequired
servicesArray of available services and their parametersyes
serviceIdService code in the processing systemyes
typePayment scheme typeyes
nameService nameyes
groupService groupno
fixedPaymentFixed payment amount flagno
countryCountry of service provisionno
inputsList of input parameters entered by the userno
inputs[].nameSystem name of the input parameterno
inputs[].requiredParameter required flagno
inputs[].titleHint for the userno
inputs[].regexpRegular expression for value validationno
displaysList of fields that may be displayed to the user after verificationno
displays[].name / required / title / regexpDescription of the returned fieldno

Response Example

{
"result": 0,
"resultMessage": "OK",
"services": [
{
"serviceId": "A0001",
"type": 0,
"name": "Test Service",
"group": "Online Games",
"fixedPayment": false,
"country": "International",
"inputs": [
{
"name": "account",
"required": true,
"title": "account"
}
]
},
{
"serviceId": "A0002",
"type": 0,
"name": "Test Service 2",
"group": "Other Services",
"fixedPayment": true,
"country": "KAZAKHSTAN",
"inputs": [
{
"name": "account",
"required": true,
"title": "Account Number",
"regexp": "^\\d{10}$"
},
{
"name": "ev_account1",
"required": true,
"title": "Order Number",
"regexp": "^\\d{10}$"
}
],
"displays": [
{
"name": "fio",
"required": true,
"title": "Full Name",
"regexp": "^.+$"
},
{
"name": "info",
"required": true,
"title": "Amount to Pay",
"regexp": "^.+$"
},
{
"name": "fixedAmount",
"required": true,
"title": "",
"regexp": "^\\d{1,9}\\.\\d{2}$"
}
]
}
]
}