Boost Wallet

Обзор

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

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

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

Схема работы

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

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

	Интерфейсы				Суммы
	Payment Page	CMS Plug-ins	Gate	Dashboard	минимум	максимум
Оплаты	+	–	+	–	–	–

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

Проведение оплат с использованием метода Boost Wallet включает в себя получение пользователем через Payment Page или в веб-сервисе мерчанта QR-кода и оплату через электронный кошелек с помощью полученного кода.

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

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

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

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

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

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

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

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

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

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

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

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

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 500000, 
      payment_currency: 'MYR', 
      project_id: 250, 
      customer_id: 'customer121',
      customer_first_name: 'Putra',
      customer_last_name: 'Cane',
      customer_phone: '60321669552',
      customer_email: 'putra@mail.com'
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+5Y1O\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

{
        "project_id": 635,
        "payment": {
            "id": "EP9a11-3704",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-22T06:20:51+0000",
            "method": "boostViaEGHL",
            "sum": {
                "amount": 10000,
                "currency": "MYR"
            },
            "description": "123"
        },
        "account": {
            "number": "qwe@qwe.qwqw"
        },
        "customer": {
            "id": "sasha",
            "phone": "555"
        },
        "operation": {
            "id": 126,
            "type": "sale",
            "status": "success",
            "date": "2019-03-22T06:20:51+0000",
            "created_date": "2019-03-22T06:20:35+0000",
            "request_id": "f587b6309ccb",
            "sum_initial": {
                "amount": 10000,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "MYR"
            },
            "provider": {
                "id": 1352,
                "payment_id": "123123",
                "date": "2019-03-22T06:20:49+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "AoBE429Tp7suALwVK81YfHPVW75FFHYyezXIZ1ZopQZDRjGEBx9kXpi5Q=="
    }

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

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

{
        "project_id": 635,
        "payment": {
            "id": "EP0ec0-9074",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T06:23:56+0000",
            "method": "boostViaEGHL",
            "sum": {
                "amount": 10,
                "currency": "MYR"
            },
            "description": "123"
        },
        "account": {
            "number": "qwe@qwe.qwqw"
        },
        "customer": {
            "id": "sasha",
            "phone": "555"
        },
        "operation": {
            "id": 1000000126,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T06:23:56+0000",
            "created_date": "2019-03-22T06:23:32+0000",
            "request_id": "73201c0a413f",
            "sum_initial": {
                "amount": 10,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 10,
                "currency": "MYR"
            },
            "provider": {
                "id": 1352,
                "payment_id": "123123",
                "date": "2019-03-22T06:23:54+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "LDuxQYuGsgNXeV6aCKbsfNec7J8pRoliCf2n0/RkmXfRL1ElQ8vTw3v0f4SFg=="
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
  "general": {
    "project_id": 318,
    "payment_id": "EP5fb7-bdg6",
    "signature": "testiuhgfcvbnm8f/kjhg\lkjhgvxbnmcvgfjdssAPOPKSJiojhbnm",
  },
  "payment": {
    "amount": 50000,
    "currency": "MYR",
    "description": "payment"
  },
  "customer": {
    "id":"2990",
    "first_name":"Petra",
    "last_name":"Davis",
    "ip_address":"172.10.123.11",
    "phone":"640991025894",
    "email":"d@df.com",
  }
}

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

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

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

"redirect_data": {
    "body": [],
    "method": "GET",
    "url": "https://onlinepayment.boost-my.com/index.php?token=c639de48340c4a532ba6a03d5"
  }

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

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

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

{
        "project_id": 635,
        "payment": {
            "id": "EPf0a7-e8d1",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-22T06:37:14+0000",
            "method": "ePayViaEGHL",
            "sum": {
                "amount": 500000,
                "currency": "MYR"
            },
            "description": "123"
        },
        "customer": {
            "phone": "640991025894"
        },
        "operation": {
            "id": 1000000128,
            "type": "sale",
            "status": "success",
            "date": "2019-03-22T06:37:15+0000",
            "created_date": "2019-03-22T06:36:43+0000",
            "request_id": "9bfe58066b0f4331c",
            "sum_initial": {
                "amount": 500000,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 500000,
                "currency": "MYR"
            },
            "provider": {
                "id": 1353,
                "payment_id": "123123",
                "date": "2019-03-22T06:37:13+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Y+RRAvAzF7aCMYHvoEsQjZf8unaN+4AtGHUICJe4POy6mRSZUbZmF55U00c7WEZZpkEQ=="
    }
}

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

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

{
        "project_id": 635,
        "payment": {
            "id": "EPe02d-985c",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T06:29:59+0000",
            "method": "ePayViaEGHL",
            "sum": {
                "amount": 10,
                "currency": "MYR"
            },
            "description": "123"
        },
        "customer": {
            "phone": "640991025894"
        },
        "operation": {
            "id": 1000000127,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T06:30:00+0000",
            "created_date": "2019-03-22T06:29:28+0000",
            "request_id": "201ed6b216c",
            "sum_initial": {
                "amount": 10,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 10,
                "currency": "MYR"
            },
            "provider": {
                "id": 1353,
                "payment_id": "123123",
                "date": "2019-03-22T06:29:57+0000",
                "auth_code": ""
            },
            "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "3nAGOrfkfY/+VqUqhSVkzpMh6eVE7ipxDRNz1IO4AxA3A=="
    }
}

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

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

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

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

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

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

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

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