Get payment recipients(en)

API: http://ip:port/services/bmms/api/agent/recipients

Method: GET

Only users who have the role ROLE_AGENT

Response example:

{
  "categories": [
    {
      "id": 100000429,
      "shortName": "communal_services",
      "logo": "publicutilities.png",
      "ord": 3,
      "names": {
        "ru": "Коммунальные услуги",
        "uz": "Kommunal xizmatlar",
        "en": "Communal services"
      }
    }
  ],
  "recipients": [
    {
      "id": 100162851,
      "shortName": "prirodniy_gaz",
      "logo": "prirodniy_gaz",
      "amountRatio": 1,
      "minAmount": 500,
      "maxAmount": 100000000,
      "ord": 14,
      "categoryId": 100000429,
      "type": "SIMPLE",
      "titles": {
        "ru": "Газ",
        "en": "Gas",
        "uz": "Gaz"
      },
      "fullNames": {
        "en": "Филиал газоснабжения \"HUDUDGAZ\"",
        "ru": "Филиал газоснабжения \"HUDUDGAZ\"",
        "uz": "Филиал газоснабжения \"HUDUDGAZ\""
      }
    }
  ],
  "fields": [
    {
      "id": 100162952,
      "name": "SERVICE_ID",
      "type": "OTHER",
      "contentType": "COMBOBOX",
      "controlType": "SELECT",
      "requireField": "REGION",
      "optional": false,
      "output": true,
      "visibility": "ALL",
      "ord": 3,
      "recipientId": 100162851,
      "prefixes": [],
      "values": [
        {
          "value": "10288,10289",
          "filterBy": "6896",
          "ord": 1,
          "titles": {
            "en": "Payment",
            "uz": "To'lov",
            "ru": "Оплата"
          },
          "descriptions": {
            "uz": "To'lov",
            "en": "Payment",
            "ru": "Оплата"
          }
        },
        {
          "value": "10254,10255",
          "filterBy": "6858",
          "ord": 1,
          "titles": {
            "ru": "Оплата",
            "uz": "To'lov",
            "en": "Payment"
          },
          "descriptions": {
            "ru": "Оплата",
            "uz": "To'lov",
            "en": "Payment"
          }
        }
      ],
      "titles": {
        "uz": "Xizmat turi",
        "ru": "Услуга",
        "en": "Service"
      },
      "descriptions": {
        "ru": "Услуга",
        "en": "Service",
        "uz": "Xizmat turi"
      }
    },
    {
      "id": 100162954,
      "name": "amount",
      "type": "AMOUNT",
      "contentType": "MONEY",
      "controlType": "TEXT",
      "validation": "500:200000000",
      "optional": false,
      "output": true,
      "visibility": "ALL",
      "ord": 5,
      "recipientId": 100162851,
      "prefixes": [],
      "values": [],
      "titles": {
        "en": "Summa",
        "ru": "Сумма",
        "uz": "Summa"
      },
      "descriptions": {
        "ru": "Сумма",
        "en": "Summa",
        "uz": "Summa"
      }
    },
    {
      "id": 100162956,
      "name": "licshet",
      "type": "ACCOUNT",
      "contentType": "STRING",
      "controlType": "TEXT",
      "optional": false,
      "output": true,
      "visibility": "ALL",
      "ord": 4,
      "recipientId": 100162851,
      "prefixes": [],
      "values": [],
      "titles": {
        "en": "Account",
        "uz": "Hisob raqami",
        "ru": "Лицевой счёт"
      },
      "descriptions": {
        "en": "Account",
        "ru": "Лицевой счёт",
        "uz": "Hisob raqami"
      }
    },
    {
      "id": 100162958,
      "name": "REGION",
      "type": "OTHER",
      "contentType": "COMBOBOX",
      "controlType": "SELECT",
      "maskSymbol": "*",
      "optional": false,
      "output": true,
      "visibility": "ALL",
      "ord": 1,
      "recipientId": 100162851,
      "prefixes": [],
      "values": [
        {
          "value": "7356",
          "ord": 14,
          "titles": {
            "ru": "Самарканд Газ",
            "uz": "Samarqand Gaz",
            "en": "Samarkand Gas"
          },
          "descriptions": {
            "en": "Samarkand Gas",
            "ru": "Самарканд Газ",
            "uz": "Samarqand Gaz"
          }
        },
        {
          "value": "6849",
          "ord": 11,
          "titles": {
            "ru": "Ташкент г. Газ",
            "en": "Tashkent c. Gas",
            "uz": "Toshkent sh. Gaz"
          },
          "descriptions": {
            "ru": "Ташкент г. Газ",
            "uz": "Toshkent sh. Gaz",
            "en": "Tashkent c. Gas"
          }
        }
      ],
      "titles": {
        "en": "Region",
        "uz": "Viloyat",
        "ru": "Регион"
      },
      "descriptions": {
        "en": "Region",
        "ru": "Регион",
        "uz": "Viloyat"
      }
    }
  ],
  "responseFields": [
    {
      "id": 100163425,
      "name": "saldo",
      "visibility": "ALL",
      "ord": 15,
      "recipientId": 100162851,
      "labels": {
        "en": "Saldo",
        "ru": "Остаток",
        "uz": "Qoldiq"
      }
    }
  ]
} 

Categories:

Field	Description
id	Identification number
shortName	Name of the category
logo	name of the logo picture
ord	order
names.ru	Name in russian
names.uz	Name in uzbek
names.en	Name in english

Recipients

Field	Description
id	Unique identifier of the field.
shortName	Short name
logo	Name of the logo file.
amountRatio	Ratio or multiplier for amount calculations. Usually 100 means require conversion.
minAmount	Minimum transaction amount allowed
maxAmount	Maximum transaction amount allowed
ord	Display order of the service within its category.
categoryId	ID of the category (e.g., “Communal services”).
type	Type of the service (one of these values: SIMPLE(any amount that entered by user), AMOUNT_DICTATOR(gave X amount, but pay amount will be X + %), INVOICE(only entered invoice number and will pay amount that given paynet) ).
titles.ru	Name in Russian.
titles.en	Name in English.
titles.uz	Name in Uzbek.
fullNames.ru	Full official name in Russian.
fullNames.en	Full official name in English.
fullNames.uz	Full official name in Uzbek.

Fields

Field	Description
id	Unique identifier of the service parameter.
name	Name of the parameter used in send request
type	Type of the parameter (one of these values: ACCOUNT (phone number, personal account number, ...) — the value that entered by user will be sent in the account field of the check request. See check process AMOUNT - the amount that entered by user will be sent in the amount field of the check request, OTHER ).
controlType	UI control type for the input field (one of the values: TEXT - for text input SELECT - for select READONLY - for read ).
requireField	Specifies dependency — this field’s values depend on the given field. This field must be disabled (cannot be filled or selected) until one of the values listed in the values section of another field with the same name and the same recipientId within fields is selected.
optional	Indicates whether the field is optional (true) or required (false).
output	Determines whether this field’s value should be included in the request.
visibility	Visible in UI (one of these values: ALL, HIDDEN).
ord	Order number used for display field order.
recipientId	ID of the recipient this field belongs to.
prefixes	Optional list of valid prefixes for the field value (e.g.: +998 for phone number ).
values	Usually present in fields where controlType = SELECT. (see details below)

---

Field values

Field	Description
value	The actual value(s) of the option
filterBy	To filter by the value that corresponds to the selected value of the field specified in requireField.
ord	Display order of the option within the list.
titles.en	Option title in English.
titles.ru	Option title in Russian.
titles.uz	Option title in Uzbek.
descriptions.en	Description of the option in English.
descriptions.ru	Description of the option in Russian.
descriptions.uz	Description of the option in Uzbek.

Response fields

Field	Description
id	Unique identifier of the response field.
name	Technical name of the field
visibility	Visible in UI (one of these values: ALL, HIDDEN).
ord	Order number used to define display or processing sequence.
recipientId	ID of the recipient to which this field belongs.
labels.en	Field label in English.
labels.ru	Field label in Russian.
labels.uz	Field label in Uzbek.