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
| Parameter | Value |
|---|---|
| Method | POST |
| URI | <url>/api/v20/services |
| URI Parameters | none |
| Body Parameters | none |
| Content-Type | application/json |
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": "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}$"
}
]
}
]
}