«Альфа-Клик»

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

Проведение оплат с использованием метода «Альфа-Клик» может выполняться двумя способами: с перенаправлением пользователей к сервису «Альфа-Клик» или с отображением инструкции пользователю для самостоятельного завершения оплаты. В любом случае для оплаты через Payment Page со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод «Альфа-Клик» можно сделать предварительно выбранным на 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. Валютой платежа может быть EUR, KZT, RUB или USD.
3. Дополнительно должен использоваться параметр customer_account_number — идентификатор пользователя в сервисе «Альфа-Клик».
4. Для предварительного выбора метода «Альфа-Клик» необходимо указывать код платёжного метода в параметре force_payment_method — alfa-click.
5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
6. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'RUB', 
      project_id: 35, 
      customer_id: 'customer1',
      customer_account_number: 'u_customer',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9tT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 386 от пользователя была успешно проведена оплата в размере 100,00 RUB со счёта № account1.

 {
        "project_id": 386,
        "payment": {
            "id": "EP1bb6-c379",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-04T11:07:22+0000",
            "method": "alfa-click",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": ""
        },
        "account": {
            "number": "account1"
        },
        "operation": {
            "id": 632,
            "type": "sale",
            "status": "success",
            "date": "2019-03-04T11:07:22+0000",
            "created_date": "2019-03-04T11:07:08+0000",
            "request_id": "e0865f7f",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1310,
                "payment_id": "94b4a6a43480d57ee45ab107",
                "date": "2018-10-26T07:25:18+0000",
                "auth_code": "",
                "endpoint_id": "alfabank"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "yMGGZSFFOatC0/gyFF2zlFgFfslBksxuYqVTjQ0T0DMIA9evlziWay30F+QBQ=="
    }

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

 {
        "project_id": 386,
        "payment": {
            "id": "EP1bb6-c379",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-04T11:07:22+0000",
            "method": "alfa-click",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": ""
        },
        "account": {
            "number": "account1"
        },
        "operation": {
            "id": 632,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-04T11:07:22+0000",
            "created_date": "2019-03-04T11:07:08+0000",
            "request_id": "e0865f7f",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1310,
                "payment_id": "94b4a6a43480d57ee45ab107",
                "date": "2018-10-26T07:25:18+0000",
                "auth_code": "",
                "endpoint_id": "alfabank"
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "yMGGZSFFOatC0/gyFF2zlFgFfslBksxuYqVTjQ0T0DMIA9evlziWay30F+QBQ=="
    }

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

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

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

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

Проведение оплат с использованием метода «Альфа-Клик» может выполняться по двум сценариям: с перенаправлением пользователей к сервису «Альфа-Клик» или с отображением инструкции пользователю для самостоятельного завершения оплаты. В случае с перенаправлением для оплаты через Gate со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay, осуществить перенаправление пользователя на сайт сервиса «Альфа-Клик» и принять оповещение о результате оплаты. В случае с отображением инструкции — отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay, подготовить и отобразить инструкцию пользователю и принять оповещение о результате оплаты.

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

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

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

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

1. Должен использоваться запрос, отправляемый методом POST на /v2/payment/online-banking/alfa-click/sale. Эта точка входа относится к группе для проведения платежей с помощью интернет-банкинга /v2/payment/online-banking/{payment_method}/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные сведения:
     • project_id — идентификатор проекта,
     • payment_id — идентификатор платежа,
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор, уникальный в рамках проекта,
     • ip_address — используемый IP-адрес,
     • account_id — логин пользователя в сервисе «Альфа-Клик»,
     • phone — номер телефона (обязательный только для пользователей из Казахстана)
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма,
     • currency — валюта платежа в формате ISO-4217 alpha-3.
3. Валютой платежа может быть EUR, KZT, RUB, USD.
4. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

{
    "general": {
        "project_id": 35,
        "payment_id": "Payment 12",
        "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+o4EVPjLyfbOQ+9ajAteg5lPk96Q=="
  },
    "customer": {
        "account_id": "account_1",
        "ip_address": "1.1.1.1",
        "id": "customer123"
  },
    "payment": {
        "amount": 10000,
        "currency": "RUB"
  }
}

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

Так как существует два сценария оплаты через сервис «Альфа-Клик», вы можете обратиться к вашему курирующему менеджеру ECommPay для консультации и выбора наиболее удобного сценария. Далее представлены формат данных, используемых для перенаправления пользователей, и пример инструкции для отображения пользователю.

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

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

"redirect_data": {
                    "body": {
                        "redirectType": "redirect"
                    },
                    "method": "GET",
                    "url": "https://alfa-click.ru/checkout/payments/?orderId=2540-a000-1fc"
                },

Для завершения оплаты с помощью инструкции со стороны веб-сервиса необходимо обеспечить подготовку и отображение пользователю этой инструкции с описанием дальнейших действий. Обязательно должен быть добавлен логотип сервиса «Альфа-Клик». Далее приведен пример инструкции, подробную информацию о подготовке вы можете уточнить у вашего курирующего менеджера ECommPay.

Рис.: Пример отображаемой инструкции

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 386 от пользователя была успешно проведена оплата в размере 100,00 RUB со счёта № account1.

 {
        "project_id": 386,
        "payment": {
            "id": "EP1bb6-c379",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-04T11:07:22+0000",
            "method": "alfa-click",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": ""
        },
        "account": {
            "number": "account1"
        },
        "operation": {
            "id": 632,
            "type": "sale",
            "status": "success",
            "date": "2019-03-04T11:07:22+0000",
            "created_date": "2019-03-04T11:07:08+0000",
            "request_id": "e0865f7f",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1310,
                "payment_id": "94b4a6a43480d57ee45ab107",
                "date": "2018-10-26T07:25:18+0000",
                "auth_code": "",
                "endpoint_id": "alfabank"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "yMGGZSFFOatC0/gyFF2zlFgFfslBksxuYqVTjQ0T0DMIA9evlziWay30F+QBQ=="
    }

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

 {
        "project_id": 386,
        "payment": {
            "id": "EP1bb6-c379",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-04T11:07:22+0000",
            "method": "alfa-click",
            "sum": {
                "amount": 10000,
                "currency": "RUB"
            },
            "description": ""
        },
        "account": {
            "number": "account1"
        },
        "operation": {
            "id": 632,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-04T11:07:22+0000",
            "created_date": "2019-03-04T11:07:08+0000",
            "request_id": "e0865f7f",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1310,
                "payment_id": "94b4a6a43480d57ee45ab107",
                "date": "2018-10-26T07:25:18+0000",
                "auth_code": "",
                "endpoint_id": "alfabank"
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "yMGGZSFFOatC0/gyFF2zlFgFfslBksxuYqVTjQ0T0DMIA9evlziWay30F+QBQ=="
    }

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

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

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

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

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

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

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

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

1. Должен использоваться запрос, отправляемый методом POST на /v2/payment/online-banking/alfa-click/refund. Эта точка входа относится к группе для проведения платежей с помощью интернет-банкинга /v2/payment/online-banking/{payment_method}/refund.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения о запросе:
     • project_id — идентификатор проекта;
     • payment_id — идентификатор платежа;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • ip_address — используемый IP-адрес;
   • payment — объект, содержащий сведения о возврате :
     • description — комментарий или описание возврата,
     • amount — сумма возврата в минорных единицах валюты (обязательный при частичном возврате),
     • currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
3. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

{
   "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
  },  
   "customer": {    
     "ip_address": "1.2.3.4" 
  },  
   "payment": {    
     "amount": 50000,    
     "currency": "RUB",
     "description": "refund_02"
 }
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 386 для пользователя был успешно проведён частичный возврат в размере 100,00 RUB на счёт account1.

{
        "project_id": 386,
        "payment": {
            "id": "EP1bb6-c379",
            "type": "purchase",
            "status": "partially refunded",
            "date": "2019-03-04T11:16:29+0000",
            "method": "alfa-click",
            "sum": {
                "amount": 50000,
                "currency": "RUB"
            },
            "description": ""
        },
        "account": {
            "number": "account1"
        },
        "operation": {
            "id": 633,
            "type": "refund",
            "status": "success",
            "date": "2019-03-04T11:16:29+0000",
            "created_date": "2019-03-04T11:16:25+0000",
            "request_id": "88c5433b45f91",
            "sum_initial": {
                "amount": 10000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1310,
                "payment_id": "94b4a6a434857ee45ab107",
                "date": "2019-03-04T11:16:28+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "NPKaC8A2wQehyGWVYTVTQ14HE4JBB+H2FVHbS1YTT9VOHG1VFJ5zqg=="
    }

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

{
        "project_id": 386,
        "payment": {
            "id": "EP1bb6-c379",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-04T11:16:29+0000",
            "method": "alfa-click",
            "sum": {
                "amount": 50000,
                "currency": "RUB"
            },
            "description": ""
        },
        "account": {
            "number": "account1"
        },
        "operation": {
            "id": 633,
            "type": "refund",
            "status": "decline",
            "date": "2019-03-04T11:16:29+0000",
            "created_date": "2019-03-04T11:16:25+0000",
            "request_id": "88c5433b45f91",
            "sum_initial": {
                "amount": 100000,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "RUB"
            },
            "provider": {
                "id": 1310,
                "payment_id": "94b4a6a434857ee45ab107",
                "date": "2019-03-04T11:16:28+0000",
                "auth_code": ""
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
        },
        "signature": "NPKaC8A2wQehyGWVYTVTQ14HE4JBB+H2FVHbS1YTT9VOHG1VFJ5zqg=="
    }

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

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

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

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

Для метода «Альфа-Клик» доступно тестирование оплат через Payment Page и Gate, а также возвратов через Gate.

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

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

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

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

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

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

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

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

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

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

Если при переходе на страницу эмулятора платёжной формы «Альфа-Клик» кнопка Success или Decline не щёлкнута в течение 30 минут, то со стороны платёжной платформы отправляется оповещение о переводе платежа в статус decline (независимо от суммы, указанной в запросе).

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

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

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

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

Если при переходе на страницу эмулятора платёжной формы «Альфа-Клик» кнопка Success или Decline не щёлкнута в течение 30 минут, то со стороны платёжной платформы отправляется оповещение о переводе платежа в статус decline (независимо от суммы, указанной в запросе).

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

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

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

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

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

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

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

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

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