«QIWI Казахстан»

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

Для оплаты через Payment Page с использованием метода «QIWI Казахстан» со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод «QIWI Казахстан» можно делать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжного метода). Полная схема проведения оплаты представлена далее.

Информация о формате запросов и параметрах вызова Payment Page при работе с методом «QIWI Казахстан», а также о формате оповещений о результатах оплат приведена далее. Общая информация о работе с API — в разделе Описание Payment Page API.

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

При формировании запросов на открытие платёжной формы с применением метода «QIWI Казахстан» необходимо учитывать следующее:

1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
   • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_amount — сумма платежа в минорных единицах валюты;
   • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
   • customer_id — идентификатор пользователя уникальный в рамках проекта.
2. Валютой платежа может быть только KZT.
3. Для предварительного выбора метода «QIWI Казахстан» необходимо указывать код qiwi-kz в параметре force_payment_method.
4. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page.
5. После указания целевых параметров необходимо составлять подпись (подробнее — в разделе Использование подписи к данным).

Таким образом, корректный запрос на открытие платёжной формы с применением метода «QIWI Казахстан» должен содержать идентификаторы проекта, пользователя и платежа, а также валюту и сумму платежа с использованием казахстанского тенге:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'KZT', 
      project_id: 10, 
      customer_id: 'customer1',
      signature: "U52k9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1...=="
    }
)

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

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

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

 {
        "project_id": 238,
        "payment": {
            "id": "test1234567890",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "method": "Qiwi Kz Wallet",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "description": "some_string"
        },
        "account": {
            "number": "123458788"
        },
        "customer": {
            "id": "12346"
        },
        "operation": {
            "id": 32832000001400,
            "type": "sale",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "created_date": "2019-04-17T10:00:04+0000",
            "request_id": "1e4d438777e6b50c502c81473db33e3aef20d2cc-2d1e186a74b95410c320258ac79d17e7c9b3a159",
            "sum_initial": {
                "amount": 1000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1196,
                "payment_id": "999990000001a11",
                "date": "2019-04-16T19:15:00+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "SF5Kyqz4geKQdUvdWxkDu7KhOqW7a3swdACgWNdjVCL3xwqKTl
                                 0JE45Rpk1g7UIWTL5fiYoa/P7qNRSciwIbcg=="
    }
}

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

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

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

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

Для оплаты через Gate с использованием метода «QIWI Казахстан» со стороны веб-сервиса необходимо:

1. Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
2. Осуществить перенаправление пользователя к форме оплаты «QIWI Казахстан».
3. Принять оповещение о результате оплаты.

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

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

При формировании запросов на оплату с применением метода «QIWI Казахстан» необходимо учитывать следующее:

1. Должен использоваться запрос /v2/payment/wallet/qiwi-kz/sale, отправляемый методом POST. Этот запрос относится к группе запросов для платежей через электронные кошельки /v2/payment/wallet/{payment_method}/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор, уникальный в рамках проекта,
     • ip_address — IP-адрес,
     • iframe — признак режима отображения страницы, встроенной в веб-страницу (iframe);
   • account — объект, содержащий сведения о счёте пользователя:
     • number — номер QIWI Кошелька;
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3;
   • return_url — объект, содержащий сведения для перенаправления пользователя в зависимости от результата проведения оплаты:
     • success — URL для перенаправления в случае проведения оплаты,
     • decline — URL для перенаправления в случае отказа в проведении оплаты.
3. Валютой платежа может быть только KZT.
4. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на оплату с применением метода «QIWI Казахстан» должен содержать идентификаторы проекта и платежа, номер QIWI Кошелька и IP-адрес пользователя, признак iframe, валюту и сумму платежа с использованием казахстанского тенге, а также URL для перенаправления пользователя:

{
  "general": {
    "project_id": 238,
    "payment_id": "test1234567890",
    "signature": "wsPEeK7EczGLgnIDqQ3qbrU54uGKjqSIfd56KHsKGnHcCS
                     Zs0N5wSbxK+AD5XbckdDEytGpOkC95GLTNVkpCWQ=="
  },
  "customer": {
    "id": "12346",
    "ip_address": "1.2.3.4"
  },
  "account": {
    "number": "123458788"
  },
  "payment": {
    "amount": 1000,
    "currency": "KZT",
    "description": "some_string"
  },
  "return_url": {
    "success": "http:success.url",
    "decline": "http:decline.url"
  },
  "interface_type": {
    "id": 3,
    "user": "test@gmail.com"
  },
  "redirect_qrcode_sent": true
}

Форматы данных для перенаправления пользователей

Для перенаправления пользователя от веб-сервиса на сайт банка необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сервиса «QIWI Казахстан» методом, указанным в redirect_data.method.

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

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

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

 {
        "project_id": 238,
        "payment": {
            "id": "test1234567890",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "method": "Qiwi Kz Wallet",
            "sum": {
                "amount": 1000,
                "currency": "KZT"
            },
            "description": "some_string"
        },
        "account": {
            "number": "123458788"
        },
        "customer": {
            "id": "12346"
        },
        "operation": {
            "id": 32832000001400,
            "type": "sale",
            "status": "success",
            "date": "2019-04-17T10:04:47+0000",
            "created_date": "2019-04-17T10:00:04+0000",
            "request_id": "1e4d438777e6b50c502c81473db33e3aef20d2cc-2d1e186a74b95410c320258ac79d17e7c9b3a159",
            "sum_initial": {
                "amount": 1000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1196,
                "payment_id": "999990000001a11",
                "date": "2019-04-16T19:15:00+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "SF5Kyqz4geKQdUvdWxkDu7KhOqW7a3swdACgWNdjVCL3xwqKTl
                                 0JE45Rpk1g7UIWTL5fiYoa/P7qNRSciwIbcg=="
    }
}

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

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

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

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

Для оплаты через Gate с использованием платёжного метода «QIWI Казахстан» со стороны веб-сервиса необходимо:

1. Обработать запрос на проверку существования лицевого счёта пользователя.
2. Отправить ответ с информацией о существовании лицевого счёта пользователя.
3. Обработать запрос на получение идентификатора платежа на стороне веб-сервиса.
4. Отправить ответ с идентификатором платежа.
5. Принять оповещение о результате оплаты.

Информация о формате запросов и параметрах инициирования оплат через Gate при работе с методом «QIWI Казахстан» и о формате оповещений о результатах оплат приведена далее.

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

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

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

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

   {
      "type":"verify",
      "project_id":111,
      "customer_id":"ov_ole8@mail.ru",
      "signature":"lY0LT8AzpR7zGce5qfYGacOuYlHGWqkMcQlqmjlsDDZI2gVcE1qVeWANnkIR7mdOqRXJnL1kO0lUmkQ0YYLWRg=="
   }

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

   Табл. 1. Допустимые коды ответов

   Код	Описание
   0	Операция успешна
   400	Ошибка подписи
   404	Лицевой счёт пользователя не существует
   500	Общая ошибка, причина должна быть описана в необязательном параметре message

   Рис.: Пример ответа на запрос

   {
      "code":0,
      "currency":"KZT",
      "additional_customer_id": "HFVDW42345"
   }

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

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

В данном случае оповещение свидетельствует о том, что в рамках проекта 238 проведена успешная оплата в размере 20,00 KZT.

{
        "project_id": 238,
        "payment": {
            "id": "1554967098",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-11T07:18:20+0000",
            "method": "Qiwi Kz Terminal",
            "sum": {
                "amount": 2000,
                "currency": "KZT"
            },
            "description": ""
        },
        "account": {
            "number": "user9876"
        },
        "operation": {
            "id": 36425000001206,
            "type": "sale",
            "status": "success",
            "date": "2019-04-11T07:18:20+0000",
            "created_date": "2019-04-11T07:18:19+0000",
            "request_id": "25f3114242a16ab1e010ebab4fe816b9d105ff33b90281",
            "sum_initial": {
                "amount": 2000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1197,
                "payment_id": "999990000001a1",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "HRcDJN84ghAJL2hPW9yUbVMm7SRPewQJuH+mz4gcipXc8sI
                         dToQunzSUEiy7w5vA3+MVIO8xHSNsQB5qCCm5kXA=="
    }
}

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

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

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

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

Для выплаты через Gate с использованием метода «QIWI Казахстан» со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате выплаты. Полная схема проведения выплаты представлена далее.

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

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

При формировании запросов на выплату с применением метода «QIWI Казахстан» необходимо учитывать следующее:

1. Должен использоваться запрос /v2/payment/wallet/qiwi-kz/payout, отправляемый методом POST. Этот запрос относится к группе запросов для проведения платежей с использованием электронных кошельков /v2/payment/wallet/{payment_method}/payout.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор,
     • ip_address — IP-адрес;
   • account — объект, содержащий сведения о счёте пользователя:
     • number — номер QIWI Кошелька;
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3.
3. Валютой платежа может быть только KZT.
4. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на выплату с применением метода «QIWI Казахстан» должен содержать идентификаторы проекта, пользователя и платежа, номер QIWI Кошелька (для зачисления средств) и IP-адрес пользователя, валюту и сумму платежа с использованием казахстанского тенге:

{
  "general": {
    "project_id": 35,
    "payment_id": "test_123",
    "signature": "kUi2x9dKHAVNU0FY"
  },
  "customer": {
    "ip_address": "185.123.193.224",
    "id":"12345"
  },
  "account": {
    "number": "9182221133"
  },
  "payment": {
    "amount": 100,
    "currency": "KZT",
  }
}

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

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

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

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

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

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

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

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

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

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