List of services

POST /v2/services · API status: stable · Signature: required

Returns the list of services and their required fields (requiredFields) for creating a payment.

Request body

Parameter	Type	Required	Description
`from`	Number	Optional	Offset. Defaults to 0 (from the first service).
`size`	Number	Optional	Number of records. Default 20, maximum 50.
`filter.status`	String[]	Optional	ENABLED, DISABLED, INACTIVE. Default [ENABLED, DISABLED].
`filter.parentId`	String	Optional	Parent category ID. Without it, all services are returned.
`locale`	String	Optional	Language of names: EN, KY, RU. Default EN.
`query`	String	Optional	Search by name (in all supported languages).

Example request

POST /v2/services

POST /v2/services HTTP/1.1
Host: api.paymentsgateway.averspay.kg
Content-Type: application/json
signature: <signature>
x-api-key: <apiKey>
x-api-timestamp: 1719900000000 // Use Date.now() for the current timestamp.

{
  "from": 0,
  "query": "",
  "locale": "EN",
  "size": 20,
  "filter": { "parentId": "kyrgyzstan" }
}

Example response (shortened)

200 OK — list of services

{
  "services": [
    {
      "id": "o-kg",
      "country": "Kyrgyzstan",
      "maxAmount": 10000,
      "minAmount": 1,
      "name_en": "O!",
      "parentId": "kg-mobile",
      "requiredFields": [
        { "fieldId": "account.value", "inputMask": "000 000 000", "keyboardType": "PHONE", "label_en": "Phone number", "prefix": "+996 " },
        { "fieldId": "service", "keyboardType": "TEXT", "value": "5" },
        { "fieldId": "total", "keyboardType": "MONEY", "label_en": "Amount" }
      ],
      "status": "ENABLED"
    }
  ],
  "statusCode": 200,
  "total": 20
}