Оплата мерчантов с баланса агента

API URL

https://paysys.uz/gateway

Список категорий мерчантов

Название метода: pam.categories
Авторизация: требуется

Позволяет получить список категорий мерчантов PaySys.

Пример запроса

{
  "method": "pam.categories",
  "id": "a29c1966-b230-48a6-87c9-aa7b605fb0a7"
}

Ответ содержит:

• categories - Список категорий мерчантов
  • id - Идентификатор категории в системе PaySys
  • key - Наименование параметра для передачи в следующий метод
  • value - Значение параметра для передачи в следующий метод
  • title - Наименование категории
  • logo - URL ссылка на логотип категории
  • order_no - Ключ сортировки категории
• request_method - Название следующего метода для запроса списка мерчантов
• mx_id - Трекер запроса

Пример ответа

{
  "id": "a29c1966-b230-48a6-87c9-aa7b605fb0a7",
  "error": null,
  "result": {
    "categories": [
      {
        "id": 1,
        "key": "category_id",
        "value": 1,
        "title": "Мобильные операторы",
        "logo": "https://paysys.uz/application/resources/img/category_1.png",
        "order_no": 1000
      },
      {
        "id": 2,
        "key": "category_id",
        "value": 2,
        "title": "Интернет провайдеры",
        "logo": "https://paysys.uz/application/resources/img/category_2.png",
        "order_no": 990
      },
      {
        "id": 6,
        "key": "category_id",
        "value": 6,
        "title": "Коммунальные услуги",
        "logo": "https://paysys.uz/application/resources/img/category_6.png",
        "order_no": 988
      },
      {
        "id": 22,
        "key": "category_id",
        "value": 22,
        "title": "Бюджетные платежи",
        "logo": "https://paysys.uz/application/resources/img/category_22.png",
        "order_no": 986
      },
      {
        "id": 16,
        "key": "category_id",
        "value": 16,
        "title": "Финансовые услуги",
        "logo": "https://paysys.uz/application/resources/img/category_16.png",
        "order_no": 984
      },
      {
        "id": 3,
        "key": "category_id",
        "value": 3,
        "title": "Телефония",
        "logo": "https://paysys.uz/application/resources/img/category_3.png",
        "order_no": 980
      },
      {
        "id": 4,
        "key": "category_id",
        "value": 4,
        "title": "Погашение кредитов",
        "logo": "https://paysys.uz/application/resources/img/category_4.png",
        "order_no": 970
      },
      {
        "id": 7,
        "key": "category_id",
        "value": 7,
        "title": "Телевидение и онлайн вещание",
        "logo": "https://paysys.uz/application/resources/img/category_7.png",
        "order_no": 960
      },
      {
        "id": 10,
        "key": "category_id",
        "value": 10,
        "title": "Благотворительность",
        "logo": "https://paysys.uz/application/resources/img/category_10.png",
        "order_no": 950
      },
      {
        "id": 12,
        "key": "category_id",
        "value": 12,
        "title": "Интернет магазины",
        "logo": "https://paysys.uz/application/resources/img/category_12.png",
        "order_no": 945
      },
      {
        "id": 5,
        "key": "category_id",
        "value": 5,
        "title": "Хостинг провайдеры",
        "logo": "https://paysys.uz/application/resources/img/category_5.png",
        "order_no": 940
      },
      {
        "id": 14,
        "key": "category_id",
        "value": 14,
        "title": "Онлайн сервисы",
        "logo": "https://paysys.uz/application/resources/img/category_14.png",
        "order_no": 940
      },
      {
        "id": 8,
        "key": "category_id",
        "value": 8,
        "title": "Авиа и ЖД билеты",
        "logo": "https://paysys.uz/application/resources/img/category_8.png",
        "order_no": 930
      },
      {
        "id": 9,
        "key": "category_id",
        "value": 9,
        "title": "Видеонаблюдение",
        "logo": "https://paysys.uz/application/resources/img/category_9.png",
        "order_no": 920
      },
      {
        "id": 11,
        "key": "category_id",
        "value": 11,
        "title": "Объявления и реклама",
        "logo": "https://paysys.uz/application/resources/img/category_11.png",
        "order_no": 900
      },
      {
        "id": 13,
        "key": "category_id",
        "value": 13,
        "title": "Игры и социальные сети",
        "logo": "https://paysys.uz/application/resources/img/category_13.png",
        "order_no": 880
      },
      {
        "id": 15,
        "key": "category_id",
        "value": 15,
        "title": "Страхование",
        "logo": "https://paysys.uz/application/resources/img/category_15.png",
        "order_no": 860
      },
      {
        "id": 17,
        "key": "category_id",
        "value": 17,
        "title": "Туристические услуги",
        "logo": "https://paysys.uz/application/resources/img/category_17.png",
        "order_no": 840
      },
      {
        "id": 18,
        "key": "category_id",
        "value": 18,
        "title": "Рекламные услуги",
        "logo": "https://paysys.uz/application/resources/img/category_18.png",
        "order_no": 830
      },
      {
        "id": 19,
        "key": "category_id",
        "value": 19,
        "title": "Обучение",
        "logo": "https://paysys.uz/application/resources/img/category_19.png",
        "order_no": 820
      },
      {
        "id": 25,
        "key": "category_id",
        "value": 25,
        "title": "Косметика и медикаменты",
        "logo": "https://paysys.uz/application/resources/img/category_25.jpg",
        "order_no": 800
      },
      {
        "id": 26,
        "key": "category_id",
        "value": 26,
        "title": "Медицина",
        "logo": "https://paysys.uz/application/resources/img/category_26.jpg",
        "order_no": 800
      },
      {
        "id": 20,
        "key": "category_id",
        "value": 20,
        "title": "Другое",
        "logo": "https://paysys.uz/application/resources/img/category_20.png",
        "order_no": 700
      },
      {
        "id": 21,
        "key": "category_id",
        "value": 21,
        "title": "Такси",
        "logo": "https://paysys.uz/application/resources/img/category_21.png",
        "order_no": 255
      },
      {
        "id": 23,
        "key": "category_id",
        "value": 23,
        "title": "Строительство и Ремонт",
        "logo": "https://paysys.uz/application/resources/img/category_23.jpg",
        "order_no": 23
      }
    ],
    "request_method": "pam.category_vendors"
  },
  "mx_id": "4248c73fb3e22c8dd67d4cbcba898199"
}

В случае некорректных параметров запроса система вернет ошибку.

---

Список мерчантов для категории

Название метода: pam.category_vendors
Авторизация: требуется

Позволяет получить список мерчантов для категории.

Запрос содержит:

• categories
  • category_id - Идентификатор категории, полученный в методе pam.categories

Пример запроса

{
  "method": "pam.category_vendors",
  "params": {
    "categories": {
      "category_id": 16
    }
  },
  "id": "83b8a299-68ac-4e8f-a47a-a9a6e921b64a"
}

Ответ содержит:

• vendors - Список мерчантов
  • id - Идентификатор мерчанта в системе PaySys
  • key - Наименование параметра для передачи в следующий метод
  • value - Значение параметра для передачи в следующий метод
  • name - Наименование мерчанта
  • short_name - Краткое наименование мерчанта
  • url - URL ссылка на сайт мерчанта
  • logo - URL ссылка на логотип мерчанта
  • description - Описание мерчанта
  • category_id - Идентификатор категории мерчанта в системе PaySys
• request_method - Название следующего метода для запроса формы оплаты мерчанта
• mx_id - Трекер запроса

Пример ответа

{
  "id": "83b8a299-68ac-4e8f-a47a-a9a6e921b64a",
  "error": null,
  "result": {
    "vendors": [
      {
        "id": 101596,
        "key": "vendor_id",
        "value": 101596,
        "name": "QIWI Кошелек",
        "short_name": "QIWI Кошелек",
        "url": "https://qiwi.com",
        "logo": "https://paysys.uz/application/resources/img/logo/99_l.png",
        "description": "",
        "category_id": 16
      }
    ],
    "request_method": "pam.vendor_form"
  },
  "mx_id": "4a494d6ddcba7184f011b23518e9486b"
}

В случае некорректных параметров запроса система вернет ошибку.

---

Форма оплаты мерчанта

Название метода: pam.vendor_form
Авторизация: требуется

Позволяет получить форму оплаты мерчанта. Для каждого мерчанта определена своя форма оплаты и свои правила проверки правильности ввода данных пользователем.

Запрос содержит:

• vendors
  • vendor_id - Идентификатор мерчанта, в методе pam.category_vendors

Пример запроса

{
  "method": "pam.vendor_form",
  "params": {
    "vendors": {
      "vendor_id": 101596
    }
  },
  "id": "53eaa7f6-b227-4bb7-8ee9-959334d667b3"
}

Ответ содержит:

• vendor_form - Поля формы, необходимые для подготовки оплаты мерчанта (описывает HTML элементы формы)
  • label - Отображаемое имя поля для пользователя
  • key - Имя поля для отправки
  • element - HTML тэг поля
    input - Текстовое поле для ввода
    select - Выбор вариантов из списка
  • type - Тип данных
    int - Целое число
    string - Строка
    float - Дробное число
  • value - Значение поля по умолчанию
  • options - Список вариантов выбора для типа поля select
    • text - Видимый текст опции для выбора
    • value - Значение опции для выбора
    • id - Идентификатор опции для выбора
  • show - Показывать ли элемент в форме
  • mask - Маска заполнения элемента
  • regex - Регулярное выражение для валидации ввода пользователя
  • placeholder - Фраза внутри пустого элемента (подсказка)
  • size - HTML атрибут - максимальная длинна ввода
  • amount_type - Код валюты для суммы пополнения
  • min_amount - Минимальное значение поля
  • max_amount - Максимальное значение поля
  • order - Сортировка элемента внутри формы
  • is_required - Признак обязательности заполнения
• request_method - Наименование следующего метода (куда нужно отправить форму)
• mx_id - Трекер запроса

Пример ответа

{
  "id": "53eaa7f6-b227-4bb7-8ee9-959334d667b3",
  "error": null,
  "result": {
    "vendor_form": [
      {
        "label": "Номер телефона получателя",
        "key": "account",
        "element": "input",
        "type": "string",
        "value": "",
        "show": 1,
        "mask": "",
        "prefix": "",
        "regex": "^\\d{11,}$",
        "placeholder": "Укажите в формате 79123456789",
        "size": 0,
        "order": 10,
        "is_required": 1
      },
      {
        "label": "Валюта кошелька",
        "key": "currency",
        "element": "select",
        "child_element": null,
        "type": "string",
        "value": "RUB",
        "options": [
          {
            "text": "RUB",
            "value": "RUB",
            "id": 1
          },
          {
            "text": "USD",
            "value": "USD",
            "id": 2
          },
          {
            "text": "EUR",
            "value": "EUR",
            "id": 3
          }
        ],
        "show": 1,
        "mask": "",
        "prefix": "",
        "regex": "^(USD|RUB|EUR)$",
        "placeholder": "",
        "size": 0,
        "order": 20,
        "is_required": 1
      },
      {
        "label": "Сумма",
        "key": "amount",
        "element": "input",
        "type": "float",
        "value": "",
        "show": 1,
        "mask": "",
        "prefix": "",
        "regex": "^[0-9]{1,10}(.)[0-9]{1,2}$",
        "placeholder": "",
        "size": 0,
        "amount_type": "uzs",
        "min_amount": 10000,
        "max_amount": 75000000,
        "order": 40,
        "is_required": 1
      },
      {
        "key": "vendor_id",
        "value": 101596,
        "show": 0,
        "is_required": 1
      }
    ],
    "request_method": "pam.check"
  },
  "mx_id": "0a9a1012af599ce9fe21006fda9ba823"
}

В случае некорректных параметров запроса система вернет ошибку.

---

Проверка данных для оплаты мерчанта

Название метода: pam.check
Авторизация: требуется

Проверяет возможность оплаты мерчанта и корректность вводимых данных, существование клиента/заказа.

Запрос содержит:

• vendor_form - Форма со списком полей и их значений

Пример запроса

{
  "method": "pam.check",
  "params": {
    "vendor_form": {
      "account": "79123456789",
      "currency": "USD",
      "amount": "12000",
      "vendor_id": 101596
    }
  },
  "id": "6d8f5743-a4e8-4074-85de-8250d8f1c426"
}

^*Здесь в поле amount указана сумма в сумах, которая будет конвертирована в USD и отправлена на QIWI кошелек пользователя.

Ответ содержит список форм для различных вариантов оплаты (см. request_method).
pam.pay_by_cash - Оплата мерчанта при помощи агентского счета в PaySys

• vendor_form - Поля для мерчанта для отправки в метод подготовки платежа (чаще всего значения из вызова этого метода)
  • key - Имя поля для отправки
  • value - Значение поля
  • show - Показывать ли элемент в форме
  • is_required - Признак обязательности заполнения
• additional_form - Дополнительные поля для отображения пользователю (в следующий метод необходимо отправлять поля с признаком обязательного заполнения)
  • label - Наименование поля
  • key - Имя поля
  • value - Значение поля
  • show - Показывать ли элемент в форме
  • is_required - Признак обязательности заполнения
• pay_form - Поля с деталями платежа от провайдера
  • key - Имя поля для отправки
  • value - Значение поля
  • show - Показывать ли элемент в форме
  • is_required - Признак обязательности заполнения

Пример ответа

{
  "id": "6d8f5743-a4e8-4074-85de-8250d8f1c426",
  "error": null,
  "result": [
    {
      "vendor_form": [
        {
          "key": "account",
          "value": "79123456789",
          "show": 0,
          "is_required": 1
        },
        {
          "key": "currency",
          "value": "USD",
          "show": 0,
          "is_required": 1
        },
        {
          "key": "amount",
          "value": "12000",
          "show": 0,
          "is_required": 1
        },
        {
          "key": "vendor_id",
          "value": 101596,
          "show": 0,
          "is_required": 1
        }
      ],
      "additional_form": [
        {
          "label": "Будет получено",
          "key": "amount_to_wallet",
          "value": "1.03 USD",
          "show": 1,
          "is_required": 0
        },
        {
          "label": "Доступная сумма для пополнения",
          "key": "wallet_limits",
          "value": "2 000 000 UZS",
          "show": 1,
          "is_required": 0
        }
      ],
      "pay_form": [],
      "available_payment_systems": [],
      "request_method": "pam.pay_by_cash"
    }
  ],
  "mx_id": "5e7ec173aaf9633aaa5c140f45e077d5"
}

В случае некорректных параметров запроса система вернет ошибку.

---

Проведение оплата мерчанта

Название метода: pam.pay_by_cash
Авторизация: требуется

Запрос содержит:

• vendor_form - Форма со списком полей и их значений

Пример запроса

{
  "id": "3597fee9-fbe5-48fc-9e7e-81edd1be3266",
  "method": "pam.pay_by_cash",
  "params": {
    "vendor_form": {
      "account": "79123456789",
      "currency": "USD",
      "amount": 12000,
      "vendor_id": 101596
    }
  }
}

Ответ содержит:

• details - Объект с деталями проведенного платежа
  • id - Промежуточный идентификатор запроса
  • masked_card_number - Номер карты (для данного метода отсутствует)
  • transaction_id - Идентификатор транзакции в системе PaySys
  • bank_transaction_id - Номер транзакции в системе PaySys (для данного метода отсутствует)
  • reference_number - Идентификатор транзакции процессингового центра (для данного метода отсутствует)
  • amount - Сумма транзакции в сумах
  • merchantId - - Идентификатор поставщика услуг в системе UZCARD ONLINE/HUMO (для данного метода отсутствует)
  • terminalId - Идентификатор терминала в системе UZCARD ONLINE/HUMO (для данного метода отсутствует)
  • date - Дата создания транзакции в секундах
• mx_id - Трекер запроса

Пример ответа

{
  "id": "3597fee9-fbe5-48fc-9e7e-81edd1be3266",
  "error": null,
  "result": {
    "details": {
      "id": "2b32d68e154573ec7b6d30d1f803c5a5",
      "masked_card_number": null,
      "transaction_id": 2355072,
      "bank_transaction_id": null,
      "reference_number": null,
      "amount": 12000,
      "merchantId": null,
      "terminalId": null,
      "date": 1653647794
    }
  }
}

В случае некорректных параметров запроса система вернет ошибку.

---

Проверка статуса платежа

Название метода: pam.check_payment
Авторизация: требуется

Запрос содержит:

• agr_transaction_id - Идентификатор платежа в системе PaySys

Пример запроса

{
  "id": "9bcce9cf-c46e-45e8-9ac5-51bf8e9180e2",
  "method": "pam.check_payment",
  "params": {
    "agr_transaction_id": 2355072
  }
}

Ответ содержит:

• bank_transaction_id - Идентификатор платежа
• amount - Сумма платежа в сумах
• date - Дата создания транзакции в секундах
• status - Статус платежа
  2 - Payment is completed
  1 - Awaiting of payment
  3 - Cancelled
  6 - Refund
  7 - Pending confirmation of debit (hold on customer's card)
  0 - Payment is created
  -1 - Error
• mx_id - Трекер запроса

Пример ответа

{
  "id": "9bcce9cf-c46e-45e8-9ac5-51bf8e9180e2",
  "error": null,
  "result": {
    "bank_transaction_id": null,
    "amount": 12000,
    "date": 1653647794,
    "status": "2"
  },
  "mx_id": "97accbff9002aa5030f668a230f094fa"
}

В случае некорректных параметров запроса система вернет ошибку.