Poli

Обзор

Poli — платёжный метод, который позволяет проводить оплаты через интернет-банкинг Poli на территории Австралии и Новой Зеландии. Проведение оплат реализовано через Payment Page и Gate.

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

Тип платёжного метода	банковские платежи
Платёжные инструменты	банковские счета платёжные карты
Регионы использования	AU, NZ
Валюты платежей	AUD, NZD
Конвертация валют	–
Оплаты	+
Выплаты	–
Оплаты по сохранённым данным	–
Полные возвраты	–
Частичные возвраты	–
Опротестования	–
Особенности	Необходимо использовать Poli Merchant style guide при разработке отображаемой пользователю платежной страницы
Организация и стоимость подключения	По согласованию с курирующим менеджером ecommpay

Схема работы

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

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

	Интерфейсы				Суммы
	Payment Page	CMS Plug-ins	Gate	Dashboard	Минимум	Максимум
Оплаты	+	–	+	–	1,00 USD	10 000,00 AUD/NZD

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

Проведение оплат с использованием метода Poli выполняется с перенаправлением пользователей в сервис Poli.

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

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

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

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

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

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

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

Пользователь на стороне веб-сервиса инициирует оплату.
От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
Запрос на проведение оплаты поступает в платёжную платформу.
Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
Пользователю отображается сгенерированная платёжная форма.
Пользователь выбирает платёжный метод Poli.
Запрос на проведение оплаты через Poli поступает в платёжную платформу.
Выполняются дальнейшая обработка запроса и его отправка в сервис Poli.
На стороне Poli выполняется обработка запроса на оплату.
От сервиса Poli к платёжной платформе передаются данные для перенаправления пользователя в сервис Poli.
Данные для перенаправления пользователя передаются к Payment Page.
Пользователь перенаправляется в сервис Poli.
Пользователь выполняет необходимые действия для оплаты.
На стороне сервиса Poli выполняется обработка платежа.
Результат оплаты отображается пользователю в сервисе Poli.
Пользователь перенаправляется к Payment Page.
От сервиса Poli к платёжной платформе направляется уведомление о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От платёжной платформы к Payment Page направляется результат проведения оплаты.
Результат оплаты отображается пользователю на Payment Page.

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

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

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

Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_amount — сумма платежа в дробных единицах валюты;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
Валютой платежа может быть только AUD или NZD.
Дополнительно должны использоваться параметры customer_email, customer_last_name, customer_first_name — адрес электронной почты, фамилия и имя пользователя в рамках проекта. Если параметры не переданы в запросе на открытие, то данные запрашиваются у пользователя на Payment Page.
Также должен передаваться параметр merchant_return_url для возможности пользователю вернуться в проект со страницы оплаты по кнопке возврата на любом шаге до завершения оплаты.
Для предварительного выбора метода Poli необходимо указывать код платёжного метода в параметре force_payment_method — poli.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
После определения всех параметров необходимо составить подпись. Подробнее — в разделе Работа с подписью к данным.

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 100000, 
      payment_currency: 'EUR', 
      project_id: 121, 
      customer_id: 'customer1',
      customer_last_name: 'Johnson',
      customer_first_name: 'John',
      customer_email: 'johnson@mail.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

    {
        "project_id": 579,
        "payment": {
            "id": "TEST_17777",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "method": "poli",
            "sum": {
                "amount": 1000,
                "currency": "AUD"
            },
            "description": "TEST_17777"
        },
        "account": {
            "number": "98742364"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 859000000758,
            "type": "sale",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "created_date": "2019-03-25T15:20:51+0000",
            "request_id": "d8287211",
            "sum_initial": {
                "amount": 1000,
                "currency": "AUD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "AUD"
            },
            "provider": {
                "id": 1199,
                "payment_id": "996117524182",
                "date": "2019-03-26T02:22:15+0000",
                "auth_code": "",
                "endpoint_id": "iBankAU01"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "bs1VNy7rlgogc/bi3YNXLut984WlYoQZLjHUs44ZDGyBJX7wECw+tAcgEYAXbo2Q=="
    }

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

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


{
        "project_id": 200,
        "payment": {
            "id": "TEST_156205789689899",
            "type": "purchase",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "method": "poli",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_156205789689899"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 23132000003336,
            "type": "sale",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "created_date": "2019-07-02T09:41:42+0000",
            "request_id": "b8780b6769",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1243,
                "payment_id": "1111920",
                "date": "2019-07-02T10:10:57+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "bxyKlCGB82Xs4KI4yeN2av6Kg/+PnNJNWKXImLYPDlm7mOg=="
    }

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

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

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

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

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

Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
Осуществить перенаправление пользователя в сервис Poli.
Принять оповещение о результате оплаты.

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

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

Пользователь на стороне веб-сервиса инициирует оплату через один из банков, поддерживающих работу с методом Poli. Необходимо использовать Poli Merchant style guide при разработке отображаемой пользователю платежной страницы.
От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
Запрос на проведение оплаты поступает в платёжную платформу.
Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Poli.
На стороне Poli выполняется обработка запроса на оплату.
От сервиса Poli к платёжной платформе передаются данные для перенаправления пользователя в сервис Poli.
От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в объекте redirect_data.
Пользователь перенаправляется в сервис Poli.
Пользователь выполняет необходимые действия для оплаты.
На стороне сервиса Poli выполняется обработка платежа.
Пользователю отображается результат оплаты.
Пользователь перенаправляется к веб-сервису.
От сервиса Poli к платёжной платформе направляется уведомление о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От веб-сервиса пользователю направляется результат оплаты.

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

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

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

Должен использоваться запрос /v2/payment/online-banking/poli/sale, отправляемый методом POST. Этот запрос относится к группе запросов через интернет-банкинг /v2/payment/online-banking/{payment_method}/sale.
В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
  - project_id — идентификатор проекта, полученный от ecommpay при интеграции;
  - payment_id — идентификатор платежа, уникальный в рамках проекта;
  - signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
  - id — идентификатор, уникальный в рамках проекта,
  - ip_address — используемый IP-адрес,
  - last_name — фамилия,
  - first_name — имя,
  - email — адрес электронной почты;
- payment — объект, содержащий сведения о платеже:
  - amount — сумма платежа в дробных единицах валюты,
  - currency — валюта платежа в формате ISO-4217 alpha-3;
Валютой платежа может быть только AUD или NZD.
Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

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

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

{
    "general": {
      "project_id": 2990,
      "payment_id": "payment_id",
      "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "ip_address": "1.1.1.1",
      "last_name": "Johnson",
      "first_name": "John",
      "email": "johnson@mail.com",
      "id": "customer123"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    }
}

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

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

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

   "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://txn.uat1.paywithpoli.com/?Token=HLRxSE9VM4zorV%2bA"

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

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

    {
        "project_id": 579,
        "payment": {
            "id": "TEST_17777",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "method": "poli",
            "sum": {
                "amount": 1000,
                "currency": "AUD"
            },
            "description": "TEST_17777"
        },
        "account": {
            "number": "98742364"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 859000000758,
            "type": "sale",
            "status": "success",
            "date": "2019-03-25T15:22:19+0000",
            "created_date": "2019-03-25T15:20:51+0000",
            "request_id": "d8287211",
            "sum_initial": {
                "amount": 1000,
                "currency": "AUD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "AUD"
            },
            "provider": {
                "id": 1199,
                "payment_id": "996117524182",
                "date": "2019-03-26T02:22:15+0000",
                "auth_code": "",
                "endpoint_id": "iBankAU01"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "bs1VNy7rlgogc/bi3YNXLut984WlYoQZLjHUs44ZDGyBJX7wECw+tAcgEYAXbo2Q=="
    }

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

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


{
        "project_id": 200,
        "payment": {
            "id": "TEST_156205789689899",
            "type": "purchase",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "method": "poli",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_156205789689899"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 23132000003336,
            "type": "sale",
            "status": "decline",
            "date": "2019-07-02T10:10:58+0000",
            "created_date": "2019-07-02T09:41:42+0000",
            "request_id": "b8780b6769",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1243,
                "payment_id": "1111920",
                "date": "2019-07-02T10:10:57+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "bxyKlCGB82Xs4KI4yeN2av6Kg/+PnNJNWKXImLYPDlm7mOg=="
    }

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

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

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

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

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

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

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

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