«Платежи с использованием карт через партнёра (Украина)»

Обзор

Платёжный метод, который позволяет проводить оплаты и выплаты с использованием платёжных карт через сервис партнёра в Украине. Оплаты осуществляются через Payment Page и Gate, выплаты — через Gate.

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

Тип платёжного метода платежи с использованием карт через партнёра
Регионы использования UA
Валюты платежей UAH
Конвертация валют
Оплаты +
Выплаты +
Оплаты по сохранённым данным
Полные возвраты
Частичные возвраты
Опротестования
Особенности
Организация и стоимость подключения по согласованию с курирующим менеджером ECommPay

Схема работы

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



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

Интерфейсы Суммы, UAH
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) минимум максимум
Оплаты + + 1,00 30 000,00
Выплаты + 1,00

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
    • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
    • payment_id — идентификатор платежа, уникальный в рамках проекта;
    • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
    • payment_amount — сумма платежа в минорных единицах;
    • customer_id — идентификатор пользователя уникальный в рамках проекта.
  2. Валютой платежа может быть только UAH.
  3. Дополнительно может использоваться параметр customer_id — идентификатор пользователя в рамках проекта.
  4. Для предварительного выбора метода необходимо указывать код платёжного метода в параметре force_payment_methodcard-visa для платежей по картам Visa или card-mc для платежей по картам Mastercard и Maestro.
  5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  6. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 30000, 
      payment_currency: 'UAH', 
      project_id: 0, 
      customer_id: 'customer1',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yoASCQ9vySO\/RL...=="
    }
)

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 159 от пользователя ALEX была успешно проведена оплата в размере 300,00 UAH с карты 473118******4111.

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

{
        "project_id": 159,
        "payment": {
            "id": "4287815",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "method": "card-visa",
            "sum": {
                "amount": 30000,
                "currency": "UAH"
            },
            "description": "deposit"
        },
        "account": {
            "number": "473118******4111"
        },
        "customer": {
            "id": "ALEX"
        },
        "operation": {
            "id": 43597000001900,
            "type": "sale",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "created_date": "2019-09-02T14:32:38+0000",
            "request_id": "f1a89d3dc77",
            "sum_initial": {
                "amount": 30000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": "162534485",
                "date": "2019-09-02T17:34:11+0000",
                "auth_code": "",
                "endpoint_id": "107001"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "T+x5ZXCbHhK36FB+B1ASRJO+LfRrgLjonhPlp6aBN...=="
    }

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

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

 {
        "payment": {
            "date": "2019-08-30T05:19:43+0000",
            "id": "TEST_1566576319342",
            "method": "card-visa",
            "status": "decline",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "type": "purchase",
            "description": "ECT_TEST_1566576319342"
        },
        "project_id": 408,
        "errors": [
            {
                "code": "2642",
                "message": "Limit Overrun Code",
                "description": "fatal: LIMIT_OVERRUN_CODE"
            }
        ],
        "operation": {
            "id": 40092000001666,
            "type": "sale",
            "status": "decline",
            "date": "2019-08-30T05:19:43+0000",
            "created_date": "2019-08-30T05:19:42+0000",
            "request_id": "d00b9813846f7383",
            "sum_initial": {
                "amount": 100,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 38,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "tFmruTrvie1nuR+2GZmnFi1e+ngVczvjO1YJM3Gehi...=="
    }

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

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

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

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

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

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

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

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

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

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

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

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

  1. Должен использоваться запрос /v2/payment/interkassa20/card-visa/sale для платежей по картам Visa или /v2/payment/interkassa20/card-mc/sale для платежей по картам Mastercard и Maestro, отправляемый методом POST. Данный запрос входит в группу запросов /v2/payment/interkassa20/{payment_method}/sale.
  2. В запросе должны использоваться следующие объекты и параметры:
    • general — основные сведения:
      • project_id — идентификатор проекта,
      • payment_id — идентификатор платежа,
      • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
    • customer — сведения о пользователе:
      • id — идентификатор, уникальный в рамках проекта,
      • ip_address — используемый IP-адрес;
    • payment — сведения о платеже:
      • amount — сумма,
      • currency — валюта платежа в формате ISO-4217 alpha-3.
  3. Валютой платежа может быть только UAH.
  4. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

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

{ 
   "general": { 
      "project_id": 159,
      "payment_id": "561719496",
      "signature": "fCkXYCxiTjiN9AkFvEZCpbe/a+wKKMv4i4Bm...=="
   },
   "customer": { 
      "id": "ALEX",
      "ip_address": "1.2.3.4"
   },
   "payment": { 
      "amount": 3000,
      "currency": "UAH"
   }
}

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

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

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

  "redirect_data": {
                    "body": {
                        "ik_am": "300.00",
                        "ik_co_id": "3c1eaf9b398",
                        "ik_cur": "UAH",
                        "ik_desc": "deposit",
                        "ik_pm_no": "43597000001900",
                        "ik_pw_via": "visa_uah",
                        "ik_suc_u": "https://example.com/process/complete-redirect?wsid=m2l22f5",
                        "ik_suc_m": "POST",
                        "ik_fal_u": "https://example.com/process/complete-redirect?wsid=m2l22f5",
                        "ik_fal_m": "POST",
                        "ik_ltm": "2578400"
                    },
                    "method": "GET",
                    "url": "https://pay.site.com/api/v1/checkout/16ebbf79/form"
                }

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 159 от пользователя ALEX была успешно проведена оплата в размере 300,00 UAH с карты 473118******4111.

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

{
        "project_id": 159,
        "payment": {
            "id": "4287815",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "method": "card-visa",
            "sum": {
                "amount": 30000,
                "currency": "UAH"
            },
            "description": "deposit"
        },
        "account": {
            "number": "473118******4111"
        },
        "customer": {
            "id": "ALEX"
        },
        "operation": {
            "id": 43597000001900,
            "type": "sale",
            "status": "success",
            "date": "2019-09-02T14:34:21+0000",
            "created_date": "2019-09-02T14:32:38+0000",
            "request_id": "f1a89d3dc77",
            "sum_initial": {
                "amount": 30000,
                "currency": "UAH"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": "162534485",
                "date": "2019-09-02T17:34:11+0000",
                "auth_code": "",
                "endpoint_id": "107001"
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "T+x5ZXCbHhK36FB+B1ASRJO+LfRrgLjonhPlp6aBN...=="
    }

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

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

 {
        "payment": {
            "date": "2019-08-30T05:19:43+0000",
            "id": "TEST_1566576319342",
            "method": "card-visa",
            "status": "decline",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "type": "purchase",
            "description": "ECT_TEST_1566576319342"
        },
        "project_id": 408,
        "errors": [
            {
                "code": "2642",
                "message": "Limit Overrun Code",
                "description": "fatal: LIMIT_OVERRUN_CODE"
            }
        ],
        "operation": {
            "id": 40092000001666,
            "type": "sale",
            "status": "decline",
            "date": "2019-08-30T05:19:43+0000",
            "created_date": "2019-08-30T05:19:42+0000",
            "request_id": "d00b9813846f7383",
            "sum_initial": {
                "amount": 100,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 38,
                "currency": "UAH"
            },
            "provider": {
                "id": 1070,
                "payment_id": ""
            },
            "code": "412",
            "message": "Amount less than allowed"
        },
        "signature": "tFmruTrvie1nuR+2GZmnFi1e+ngVczvjO1YJM3Gehi...=="
    }

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

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

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

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

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

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

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

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

Валютой выплаты через сервис партнёра может быть только UAH.

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

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

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

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

Для данного платёжного метода доступно тестирование оплат через Payment Page и Gate.

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

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

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

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

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

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

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

  1. Отправить в платёжную платформу корректный тестовый запрос на открытие Payment Page.
  2. Если в запросе не был указан метод card-visa или card-mc — выбрать метод на странице эмулятора.
  3. Щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы).
  4. Принять оповещение с информацией о результате оплаты.

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

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

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

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

Подробная информация о проведении оплат с использованием данного метода через Gate представлена в пункте Оплаты через Gate.

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

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

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

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

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

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