Kassa24 Terminal

Общая информация

Информация о формате запросов и параметрах инициализации оплат методом Kassa24 Terminal через Gate, а также о формате оповещений о результатах оплат приведена далее. Общая информация о работе с API представлена в разделе Работа с API.

Формат запросов

При работе с запросами на проверку существования лицевого счёта пользователя необходимо учитывать следующее:

1. Запрос verify для проверки существования лицевого счёта пользователя отправляется методом POST на заданный URL веб-сервиса.
2. Запрос содержит следующие обязательные параметры:
   • action — тип операции на стороне веб-сервиса, значение параметра всегда verify;
   • site_login — идентификатор пользователя в системе мерчанта;
   • site_id — идентификатор проекта, полученный от ECommPay при интеграции;
   • signature — подпись запроса.

   Рис.: Пример запроса на проверку существования лицевого счёта пользователя

    {
       "action": "verify",   
       "site_id": "1487",
       "site_login": "123456789",
       "signature": "e19695449545fac562843ca06e7e0f3e51281ad6"
   }

3. Ответ на запрос verify должен быть отправлен синхронно и содержать следующие обязательные параметры:
   • code — код ответа на запрос;
   • currency — валюта платежа в формате ISO-4217 alpha-3.

Корректный ответ на запрос должен содержать код ответа на запрос и валюту платежа.

{
    "code": 0,
    "error_description": "",
    "currency": "KZT"
}

1. Запрос check_deposit для получения идентификатора платежа на стороне веб-сервиса отправляется методом POST на заданный URL веб-сервиса.
2. Запрос содержит следующие обязательные параметры:
   • action — тип операции на стороне веб-сервиса, значение параметра всегда check_deposit;
   • site_login — идентификатор пользователя в системе мерчанта;
   • site_id — идентификатор проекта, полученный от ECommPay при интеграции;
   • amount — сумма платежа в минорных единицах;
   • currency — валюта платежа в формате ISO-4217 alpha-3;
   • payment_group_id — идентификатор платёжной группы, значение параметра всегда kassa24;
   • signature — подпись запроса.

   Рис.: Пример запроса на получение идентификатора платежа на стороне веб-сервиса

   {
       "action": "check_deposit",   
       "site_id": "1487",
       "site_login": "123456789",
       "signature": "e19695449545fac562843ca06e7e0f3e51281ad6",
       "amount": "10000",
       "currency": "KZT",
       "payment_group_id":"kassa24"
   }

3. Ответ на запрос check_deposit должен быть отправлен синхронно и содержать следующие обязательные параметры:
   • code — код ответа на запрос;
   • external_id — уникальный идентификатор платежа на стороне веб-сервиса.

Корректный ответ на запрос получения идентификатора платежа на стороне веб-сервиса должен содержать код ответа на запрос и уникальный идентификатор платежа на стороне веб-сервиса.

{
    "code": 0,
    "external_id": "12365",
    "description": "sale"
}

Формат оповещений

Для оповещений о результатах оплат с применением метода Kassa24 Terminal используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 2275 была успешно проведена оплата в размере 100,00 KZT.

{
        "project_id": 2275,
        "customer": {
            "id": "4444"
        },
        "payment": {
            "id": "1549267511",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-04T08:05:17+0000",
            "method": "kassa24",
            "sum": {
                "amount": 10000,
                "currency": "KZT"
            },
            "is_new_attempts_available": false,
            "attempts_timeout": 0,
            "description": ""
        },
        "customer_data": {
            "ip_address": "192.168.15.15"
        },
        "fee": {
            "amount": 2910,
            "currency": "KZT"
        },
        "merchant_account_id": 2275,
        "operation": {
            "id": 8,
            "type": "sale",
            "status": "success",
            "date": "2019-02-04T08:05:17+0000",
            "created_date": "2019-02-04T08:05:13+0000",
            "request_id": "c4e54119785dd37f18d8d9f585d6be2ff25d8d79c41e8",
            "sum_initial": {
                "amount": 10000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "KZT"
            },
            "provider": {
                "id": 2275,
                "payment_id": "1549267510",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "nOAt011EDZ9uw8JindTcrZnOr7F5M2ZObxBAqUPjHUv/L3
                         AjYNOdKvF9tFOER6QH/5L7e0d4Q8y8nCUs/2YqDA=="
    }

Дополнительные материалы

Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация о выполнении операций

Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Kassa24 Terminal доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.

Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.

Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:

• Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
• Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.

С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.