«QIWI Кошелёк»

Обзор

«QIWI Кошелёк» — платёжный метод для платежей с использованием электронного кошелька QIWI. Оплаты осуществляются через Payment Page и Gate, выплаты и возвраты — через Gate.

Характеристика

Тип платёжного метода Платежи с использованием электронного кошелька
Регионы использования Все страны
Валюты платежей EUR, RUB, USD
Конвертация валют
Оплаты +
Выплаты +
Оплаты по сохранённым данным
Полные возвраты +
Частичные возвраты
Опротестования
Особенности Если оплата через Payment Page происходит с предварительно выбранным платёжным методом и параметр customer_phone передан, то пользователь сразу перенаправляется на страницу его личного кабинета в «QIWI Кошелёк»
Организация и стоимость подключения По согласованию с курирующим менеджером ECommPay

Схема работы

В проведении отдельного платежа с использованием «QIWI Кошелёк» задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства «QIWI Кошелёк».



Основные операции

Интерфейсы Суммы Время**
Payment Page Mobile SDKs CMS Plug-ins Gate Dashboard (Old Dashboard) минимум максимум базовое предельное
Оплаты + + + * * * *
Выплаты + * * * *
Полные возвраты + * * * *

* Необходимо уточнять у курирующего менеджера ECommPay.

** Базовое и предельное время определяются следующим образом:
  • Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
  • Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус decline. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.

Сценарии использования

Проведение оплат с использованием метода «QIWI Кошелёк» выполняется с перенаправлением пользователей к сервису QIWI, проведение выплат и возвратов — с уведомлением пользователей через веб-сервис мерчанта.

Рис.: Оплата через Payment Page



Рис.: Оплата через Gate



Рис.: Возврат через Gate



Рис.: Выплата через Gate



Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.

Оплаты через Payment Page

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

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



Рис.: Проведение оплаты через Payment Page

  1. Пользователь на стороне веб-сервиса инициирует оплату.
  2. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
  3. Запрос на проведение оплаты поступает в платёжную платформу.
  4. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  5. Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
  6. Пользователю отображается сгенерированная платёжная форма.
  7. Пользователь выбирает для оплаты метод «QIWI Кошелёк».
  8. Запрос на проведение оплаты через «QIWI Кошелёк» поступает в платёжную платформу.
  9. Выполняются дальнейшая обработка запроса и его отправка в сервис «QIWI Кошелёк».
  10. На стороне «QIWI Кошелёк» выполняется обработка запроса на оплату.
  11. От сервиса «QIWI Кошелёк» к платёжной платформе передаются данные для перенаправления пользователя в сервис «QIWI Кошелёк».
  12. Данные для перенаправления пользователя передаются к Payment Page.
  13. Пользователь перенаправляется в сервис «QIWI Кошелёк».
  14. Пользователь подтверждает платёж с использованием логина и пароля к личному кабинету «QIWI Кошелёк».
  15. На стороне сервиса «QIWI Кошелёк» выполняется обработка платежа.
  16. Результат оплаты отображается пользователю в сервисе «QIWI Кошелёк».
  17. Пользователь перенаправляется к Payment Page.
  18. От сервиса «QIWI Кошелёк» к платёжной платформе направляется результат оплаты.
  19. От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
  20. От платёжной платформы к Payment Page направляется результат проведения оплаты.
  21. Результат оплаты отображается пользователю на Payment Page.

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

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

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

  1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
    • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
    • payment_id — идентификатор платежа, уникальный в рамках проекта;
    • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
    • payment_amount — сумма платежа в минорных единицах;
    • customer_id — идентификатор пользователя уникальный в рамках проекта.
  2. Валютой платежа может быть одна из следующих валют EUR, RUB, USD.
  3. Для предварительного выбора метода «QIWI Кошелёк» необходимо указывать код платёжного метода в параметре force_payment_methodqiwi. А для перенаправления на страницу личного кабинета «QIWI Кошелёк» необходимо также передать параметр customer_phone — номер телефона пользователя, который является номером электронного кошелька «QIWI Кошелёк».
  4. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  5. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 100, 
      payment_currency: 'USD', 
      project_id: 0, 
      customer_id: 'customer1',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 481 была успешно проведена оплата в размере 50,00 EUR со счёта № 79503239672.

Рис.: Пример оповещения о проведенной оплаты

{
        "project_id": 481,
        "payment": {
            "id": "1207007",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-10T09:54:45+0000",
            "method": "qiwi",
            "sum": {
                "amount": 5000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "79503239672"
        },
        "operation": {
            "id": 44932000002349,
            "type": "sale",
            "status": "success",
            "date": "2019-09-10T09:54:45+0000",
            "created_date": "2019-09-10T09:54:14+0000",
            "request_id": "66e7615d7658a741a09858e2c82868eac3e571dc78fcf164a50",
            "sum_initial": {
                "amount": 5000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 361650,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": "44932000002349",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "liDM865/azvMYLt3PHGQ06sJ1636giqSMtMmF6cybmWupmDksqdIBruH
                                             8x2dHcv5bPgE4rfgXPpz21Osvj3+8w=="
    }
}

В следующем примере оплата была отклонена из-за недостатка средств на счёте аккаунта пользователя.

Рис.: Пример оповещения об отказе в проведении оплаты

{
        "project_id": 477,
        "payment": {
            "id": "2496584",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-10T08:43:10+0000",
            "method": "qiwi",
            "sum": {
                "amount": 15000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "79500232022"
        },
        "operation": {
            "id": 46483000002283,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-10T08:43:10+0000",
            "created_date": "2019-09-09T07:10:08+0000",
            "request_id": "9f4fa47f818c7ba46fc1815580c464878772ace205da8d36b7",
             "sum_initial": {
                "amount": 15000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1084950,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": "46483000002283",
                "result_code": "0",
                "result_message": "expired",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account",
            "description": "Operation was declined due to insufficient funds on the customer account"
        },
        "signature": "no/72vXyh8gWwUOUtBC2yAAgJ49CUkwlaz25k0btVRc7+0xLOluAICLpw
                                               4hPyZcnoOYbNY4uzSKhJHNjgRGIDQ=="
    }
}

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

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

Оплаты через Gate

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

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

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

Полная схема проведения оплаты представлена далее.



Рис.: Проведение оплаты через Gate

  1. Пользователь на стороне веб-сервиса инициирует оплату через «QIWI Кошелёк».
  2. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
  3. Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
  4. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  5. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
  6. В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис «QIWI Кошелёк».
  7. На стороне «QIWI Кошелёк» выполняется обработка запроса на оплату.
  8. От сервиса «QIWI Кошелёк» к платёжной платформе передаются данные для перенаправления пользователя на сайт «QIWI Кошелёк».
  9. От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в «QIWI Кошелёк» в объекте redirect_data.
  10. Пользователь перенаправляется в сервис «QIWI Кошелёк».
  11. Пользователь подтверждает платёж с использованием логина и пароля к личному кабинету «QIWI Кошелёк».
  12. На стороне сервиса «QIWI Кошелёк» выполняется обработка платежа.
  13. Пользователю отображается результат оплаты.
  14. Пользователь перенаправляется к веб-сервису.
  15. От сервиса «QIWI Кошелёк» к платёжной платформе направляется уведомление о результате оплаты.
  16. От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
  17. От веб-сервиса пользователю направляется результат оплаты.

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

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

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

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

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

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

{
    "general": {
        "project_id": 35,
        "payment_id": "Payment 12",
        "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+2AbrQgJguu0BQjXWH6naCA9Ts6o4EV
                                                           Pjlyfboq+9ajAteg5lPk96Q=="
  },
    "customer": {
        "ip_address": "1.1.1.1",
        "id": "customer123"
},
    "account": {
        "number": "79039999999"
  },
    "payment": {
        "amount": 10000,
        "currency": "EUR"
  }
}

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

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

Далее приведён фрагмент оповещения, содержащего данные для перенаправления.

"redirect_data": {
    "body": {
      "shop": "12345",
      "transaction": 34700000003226,
      "iframe": "false",
      "successUrl": "test.com/success",
      "failUrl": "test.com/fail",
      "target": "iframe"
    },
    "method": "GET",
    "url": "https://bill.qiwi.com/order/external/main.action"
  }

В результате должна получиться следующая ссылка для перенаправления пользователя https://bill.qiwi.com/order/external/main.action?shop=12345&transaction=34723000002456&iframe=false&successUrl=http://test.com/success&failUrl=http://test.com/fail&.

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 481 была успешно проведена оплата в размере 50,00 EUR со счёта № 79503239672.

Рис.: Пример оповещения о проведенной оплаты

{
        "project_id": 481,
        "payment": {
            "id": "1207007",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-10T09:54:45+0000",
            "method": "qiwi",
            "sum": {
                "amount": 5000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "79503239672"
        },
        "operation": {
            "id": 44932000002349,
            "type": "sale",
            "status": "success",
            "date": "2019-09-10T09:54:45+0000",
            "created_date": "2019-09-10T09:54:14+0000",
            "request_id": "66e7615d7658a741a09858e2c82868eac3e571dc78fcf164a50",
            "sum_initial": {
                "amount": 5000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 361650,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": "44932000002349",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "liDM865/azvMYLt3PHGQ06sJ1636giqSMtMmF6cybmWupmDksqdIBruH
                                             8x2dHcv5bPgE4rfgXPpz21Osvj3+8w=="
    }
}

В следующем примере оплата была отклонена из-за недостатка средств на счёте аккаунта пользователя.

Рис.: Пример оповещения об отказе в проведении оплаты

{
        "project_id": 477,
        "payment": {
            "id": "2496584",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-10T08:43:10+0000",
            "method": "qiwi",
            "sum": {
                "amount": 15000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "79500232022"
        },
        "operation": {
            "id": 46483000002283,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-10T08:43:10+0000",
            "created_date": "2019-09-09T07:10:08+0000",
            "request_id": "9f4fa47f818c7ba46fc1815580c464878772ace205da8d36b7",
             "sum_initial": {
                "amount": 15000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1084950,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": "46483000002283",
                "result_code": "0",
                "result_message": "expired",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account",
            "description": "Operation was declined due to insufficient funds on the customer account"
        },
        "signature": "n7/72vXyh8gWwUOUtBC2yAAgJ49CUkwlaz25k0btVRc7+0xLOluAICLpw
                                               4hPyZcnoOYbNY4uzSKhJHNjgRGIDQ=="
    }
}

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

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

Возвраты через Gate

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

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



Рис.: Проведение возврата через Gate

  1. Пользователь запрашивает возврат.
  2. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение возврата.
  3. Запрос на проведение возврата поступает в платёжную платформу ECommPay.
  4. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  5. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
  6. В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис «QIWI Кошелёк».
  7. На стороне «QIWI Кошелёк» выполняется обработка платежа.
  8. От «QIWI Кошелёк» к платёжной платформе направляется оповещение о результате.
  9. От платёжной платформы к веб-сервису направляется оповещение о результате.
  10. От веб-сервиса пользователю направляется результат возврата.

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

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

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

  1. Должен использоваться запрос /v2/payment/qiwi/refund, отправляемый методом POST.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — основные сведения:
      • project_id — идентификатор проекта,
      • payment_id — идентификатор платежа;
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
    • payment — сведения о платеже:
      • description — комментарий или описание возврата.
  3. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

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

{
  "general": {
    "project_id": 35,
    "payment_id": "Payment 12",
    "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+2AbrQgJguu0BQjXWH6naC
                                     A9Ts6o4EVPjlyfboq+9ajAteg5lPk96Q=="
  },
  "payment": {
    "description": "Refund"
  }
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 135 для пользователя 1 был успешно проведён полный возврат в размере 9,88 USD на счёт № 79165354204.

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

{
        "project_id": 135,
        "payment": {
            "type": "purchase",
            "sum": {
                "amount": 0,
                "currency": "USD"
            },
            "status": "refunded",
            "method": "qiwi",
            "id": "ECT_TEST_1566292942896",
            "date": "2019-08-26T10:52:04+0000",
            "description": "ECT_TEST_1566292942896"
        },
        "customer": {
            "id": "1"
        },
        "account": {
            "number": "79165354204"
        },
        "operation": {
            "id": 47003000001425,
            "type": "refund",
            "status": "success",
            "date": "2019-08-26T10:52:04+0000",
            "created_date": "2019-08-26T10:52:02+0000",
            "request_id": "b6f322b36fec4a35264c652bacd73695a2e970a9287faee7cf",
            "sum_initial": {
                "amount": 988,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 65025,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": "5jxuu8dut",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "ls/fOKQSg4YT/FcheW5X+HV1VE/ZH/fgTHDvGTeZy5s97U2YFSL8EqVHVc6P4
                                                       GT5hubvKybMqdyYzDvwaObYzA=="
    }
}

В следующем примере возврат был отклонён по причине того, что аккаунт пользователя истек или недоступен.

Рис.: Пример оповещения об отказе в проведении возврата

{
        "project_id": 460,
        "payment": {
            "id": "Demo_zqw1",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-02T09:33:42+0000",
            "method": "qiwi",
            "sum": {
                "amount": 988,
                "currency": "USD"
            },
            "description": "Test"
        },
        "account": {
            "number": "9088889977"
        },
        "customer": {
            "id": "Demo"
        },
        "operation": {
            "id": 26740000000119,
            "type": "refund",
            "status": "decline",
            "date": "2019-03-02T09:41:08+0000",
            "created_date": "2019-03-02T09:41:07+0000",
            "request_id": "724a9bffdd63f5e61e73d78f517d85a51075b589fee38002",
            "sum_initial": {
                "amount": 988,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 65025,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": ""
            },
            "code": "20106",
            "message": "Customer account is no longer available"
        },
        "signature": "hE0T4t2cONjWo5XsXDnO8eZqPVwvnYldS2bfrweP0JxXIOTMWwZBmFMiI3IDvX
                                                         FQKxACF9MtawyxEG1EZfc4rw=="
    }
}

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

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

Выплаты через Gate

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

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



Рис.: Проведение выплаты через Gate

  1. Пользователь на стороне веб-сервиса инициирует выплату через «QIWI Кошелёк».
  2. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
  3. Запрос на проведение выплаты поступает в платёжную платформу.
  4. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  5. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
  6. В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис «QIWI Кошелёк».
  7. На стороне «QIWI Кошелёк» выполняется обработка платежа.
  8. От «QIWI Кошелёк» к платёжной платформе направляется оповещение о результате.
  9. От платёжной платформы к веб-сервису направляется оповещение о результате.
  10. От веб-сервиса пользователю направляется результат выплаты.

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

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

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

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

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

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

{
    "general": {
        "project_id": 35,
        "payment_id": "Payment 12",
        "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+2AbrQgJguu0BQjXWH6n
                                     aCA9Ts6o4EVPjlyfboq+9ajAteg5lPk96Q=="
  },
    "customer": {
        "id": "321"
        "ip_address": "1.1.1.1"
  },
    "payment": {
        "amount": 10000,
        "currency": "EUR",
        "description": "Test payout"
  },
    "account": {
        "number": "79039999999"
  }
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 1483 для пользователя iy280590@gmail.com была успешно проведена выплата в размере 50,00 EUR.

Рис.: Пример оповещения о проведенной выплате

{
        "project_id": 1483,
        "payment": {
            "id": "852af08d-1ff0-46a4-af4b-c4f3e9664d5b",
            "type": "payout",
            "status": "success",
            "date": "2019-09-12T10:23:43+0000",
            "method": "qiwi",
            "sum": {
                "amount": 5000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "79610818551"
        },
        "customer": {
            "id": "iy280590@gmail.com"
        },
        "operation": {
            "id": 46266000002521,
            "type": "payout",
            "status": "success",
            "date": "2019-09-12T10:23:43+0000",
            "created_date": "2019-09-12T10:23:30+0000",
            "request_id": "0cc015ea0cfaf822ad8f0d0bf4ebf5aa02659d23940db61fd718",
            "sum_initial": {
                "amount": 5000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 361650,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": "16401320435",
                "date": "2019-09-12T13:23:32+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "AYjholAnDB4f0+GnlaVnzXweILICE/f+mJxR73+fbbcFv+wYC8IPFoWEaEgE8T
                                                         McQi7CohSKh38y7fBu+y+Mgw=="
    }
}

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

Рис.: Пример оповещения об отказе в проведении выплаты

{
        "project_id": 1483,
        "payment": {
            "id": "852af08d-1ff0-46a4-af4b-c4f3e9664d5b",
            "type": "payout",
            "status": "decline",
            "date": "2019-09-12T10:23:43+0000",
            "method": "qiwi",
            "sum": {
                "amount": 5000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "79610818551"
        },
        "customer": {
            "id": "siy280590@gmail.com"
        },
        "operation": {
            "id": 46266000002521,
            "type": "payout",
            "status": "decline",
            "date": "2019-09-12T10:23:43+0000",
            "created_date": "2019-09-12T10:23:30+0000",
            "request_id": "0cc015ea0cfaf822ad8f0d0bf4ebf5aa02659d23940db61fd718",
            "sum_initial": {
                "amount": 5000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 361650,
                "currency": "RUB"
            },
            "provider": {
                "id": 416,
                "payment_id": "16401320435",
                "date": "2019-09-12T13:23:32+0000",
                "auth_code": ""
            },
            "code": "20106",
            "message": "Customer account is no longer available"
        },
        "signature": "AYjholAnDB4f0+GnlaVnzXweILICE/f+mJxR73+fbbcFv+wYC8IPFoWEaEgE8T
                                                         McQi7CohSKh38y7fBu+y+Mgw=="
    }
}

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

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

Тестирование

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

Для метода «QIWI Кошелёк» доступно тестирование оплат через Payment Page и Gate, а также возвратов и выплат через Gate.

Тестирование может выполняться в рамках тестового проекта, и для подключения и отключения этой функциональности необходимо обращаться к специалистам технической поддержки ECommPay support@ecommpay.com.

При проведении тестовых платежей следует учитывать, что в запросах должен указываться идентификатор тестового проекта, в качестве валюты может использоваться только RUB, а интерфейсы эмулятора платёжных форм Payment Page и «QIWI Кошелёк» могут отличаться от рабочих.



Статусы тестовых платежей

При тестировании оплат их итоговые статусы определяются исходя из сумм, указанных в запросах:

  • decline — при указании суммы 40000 или 40400,
  • success — при указании любой другой суммы.

При тестировании возвратов их итоговые статусы определяются исходя из сумм, указанный в запросах:

  • decline — при указании суммы 50000 или 50500,
  • success — при указании любой другой суммы.

При тестировании выплат их итоговые статусы определяются исходя из сумм, указанных в запросах:

  • decline — при указании суммы 40000 или 40400,
  • success — при указании любой другой суммы.

Оплаты через Payment Page

Для проведения тестовой оплаты через Payment Page необходимо:

  1. Отправить в платёжную платформу корректный тестовый запрос на открытие Payment Page.
  2. Если в запросе не был указан метод qiwi — выбрать метод «QIWI Кошелёк» на странице эмулятора.
  3. Указать в поле ввода произвольный номер телефона (для тестирования достаточно указывать от одной цифры).
  4. Щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы).
  5. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода «QIWI Кошелёк» через Payment Page представлена в пункте Оплаты через Payment Page.

Оплаты через Gate

Для проведения тестовой оплаты через Gate необходимо:

  1. Отправить в платёжную платформу корректный тестовый запрос на оплату.
  2. Принять оповещение с данными для перенаправления.
  3. Перейти по полученному URL и щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы) — на странице эмулятора.
  4. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода «QIWI Кошелёк» через Gate представлена в пункте Оплаты через Gate.

Возвраты через Gate

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

Следует учитывать, что выполнение тестового возврата на полную или частичную сумму возможно только в течение суток после проведения оплаты. Подробная информация о проведении возвратов с использованием метода «QIWI Кошелёк» через Gate представлена в пункте Возвраты через Gate.

Выплаты через Gate

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

Анализ результатов проведения платежей

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

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

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

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

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