Payment.Systems.Get

Возвращает каталог платёжных систем VCR, их сценарии, состояние настройки и поддерживаемые операции. Метод не возвращает адреса, учётные данные и секретные ключи.

Входные параметры

Метод не принимает параметров. Передавайте пустой объект params.

{
    "jsonrpc": "2.0",
    "method": "Payment.Systems.Get",
    "params": {},
    "auth": "a2Fzc2E6a2FzMTIzNDU2",
    "id": 1
}

Выходные параметры

Поля элемента systems:

Поля элемента operations:

Каталог не содержит локализованных текстов. Значения code, scenario, customer_action и коды вариантов полей являются машинными кодами.

Для сценария biometric каталог возвращает операции Biometric.Register, Biometric.Identify, Payment.Create и Payment.Get. Biometric.Register регистрирует выбранную руку по одноразовой QR-сессии клиента. После распознавания Payment.Create принимает последние четыре цифры телефона клиента в поле token и использует активную сессию текущего авторизованного кассира. Операция Payment.Cancel отсутствует, поскольку KaftPay не предоставляет отмену через POS API.

Значение обязательного поля device_id POS получает методом Biometric.Device.Get. Тип устройства, драйвер и формат биометрических данных в каталог не включаются.

code и payment_system_id стабильны. POS рекомендуется сохранять локальное сопоставление формы оплаты по code, а при вызове VCR использовать актуальный payment_system_id из каталога.

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

• Если POS не поддерживает scenario, платёжная система не показывается кассиру.
• Если операция содержит неизвестное обязательное поле, POS не разрешает эту операцию.
• Неизвестные необязательные поля, поля результата и другие поля JSON игнорируются.
• Неизвестный customer_action означает, что операция недоступна в этой версии POS.
• Если POS не поддерживает next_method, операция недоступна в этой версии POS.
• Неподдерживаемая POS операция не отключает остальные операции той же системы.

Для Payment.Get и Payment.Cancel поле params.payment_id всегда содержит внутренний UUID Payment.Create.result.id. Внешнее поле Payment.Create.result.payment_id для этих вызовов не используется.

После тайм-аута асинхронной операции POS не должен автоматически создавать платёж или возврат повторно. Проверка продолжается указанным в polling.method методом.

Сокращённый пример ответа

{
  "jsonrpc": "2.0",
  "result": {
    "schema_version": 1,
    "systems": [
      {
        "payment_system_id": -3,
        "code": "posretail",
        "name": "POSRetail",
        "scenario": "terminal",
        "supported": true,
        "enabled": true,
        "configured": true,
        "available": true,
        "sort_order": 10,
        "field_options": {
          "card_type": [
            { "value": 1, "code": "corporate" },
            { "value": 2, "code": "personal" },
            { "value": 3, "code": "social" }
          ]
        },
        "operations": [
          {
            "method": "Payment.Create",
            "completion": "synchronous",
            "required_fields": ["payment_system_id", "amount", "card_type"],
            "optional_fields": ["description"],
            "result_fields": ["id", "payment_system_id", "payment_id", "status", "amount"]
          },
          {
            "method": "Payment.Cancel",
            "completion": "synchronous",
            "required_fields": ["payment_id"],
            "optional_fields": [],
            "result_fields": ["id", "payment_system_id", "payment_id", "status", "amount", "refund"],
            "amount_mode": "full",
            "next_method": "Receipt.Refund",
            "next_method_statuses": [5]
          }
        ]
      }
    ]
  },
  "ok": true,
  "id": 1
}

Для асинхронного создания UzQR каталог возвращает:

"polling": {
  "method": "Payment.Get",
  "id_source": "result.id",
  "request_field": "payment_id",
  "status_field": "status",
  "interval_seconds": 2,
  "timeout_seconds": 180,
  "pending_statuses": [1, 2],
  "success_statuses": [3],
  "failure_statuses": [-1, 5]
}

Если Payment.Cancel запустил асинхронный возврат, POS продолжает использовать UUID исходного платежа, переданный в Payment.Cancel.params.payment_id:

"polling": {
  "method": "Payment.Get",
  "id_source": "request.payment_id",
  "request_field": "payment_id",
  "status_field": "refund.status",
  "interval_seconds": 2,
  "timeout_seconds": 180,
  "pending_statuses": [1, 2, 4],
  "success_statuses": [5, 6],
  "failure_statuses": [8],
  "unknown_statuses": [9]
}

Статус возврата 5 не является состоянием для дальнейшего ожидания: денежный возврат уже подтверждён, и POS должен вызвать указанный next_method — Receipt.Refund. После успешной регистрации чека Payment.Get вернёт refund.status = 6.