PayMaya
Обзор
PayMaya — метод для проведения платежей с использованием электронного кошелька. Оплаты осуществляются через Payment Page и Gate, выплаты — через Gate и Dashboard.
Характеристика
Тип платёжного метода | платежи с использованием электронных кошельков |
---|---|
Регионы использования | PH |
Валюты платежей | PHP |
Конвертация валют | на стороне ECommPay |
Оплаты | + |
Выплаты | + |
Повторяемые оплаты | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | проведение выплаты какому-либо пользователю допустимо только после проведения оплаты этим пользователем одним из следующих платёжных методов: Coins.ph, GCash, GrabPay, PayMaya |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием PayMaya задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства PayMaya.
Основные операции
Интерфейсы | Суммы, PHP | Время* | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | 20,00 | 15 000,00 | 30 минут | 1 день |
Выплаты | – | – | + | + | 1,00 | 20 000,00 | 24 часа | 48 часов |
* Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.
Сценарии использования
Проведение оплат с использованием метода PayMaya выполняется с перенаправлением пользователей к сервису PayMaya, проведение выплат — с уведомлением пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Выплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода PayMaya со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод PayMaya можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется формирование Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сформированная платёжная форма.
- Пользователь выбирает для оплаты электронный кошелёк PayMaya.
- Запрос на проведение оплаты через PayMaya поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис PayMaya.
- На стороне PayMaya выполняется обработка запроса на оплату.
- От сервиса PayMaya к платёжной платформе передаются данные для перенаправления пользователя в сервис PayMaya.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис PayMaya.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса PayMaya выполняется обработка платежа.
- Со стороны PayMaya пользователю по электронной почте отправляется информация о результате оплаты.
- Пользователь перенаправляется к Payment Page.
- От сервиса PayMaya к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с PayMaya, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода PayMaya необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа, указанная без дробной части;
- customer_id — идентификатор пользователя, уникальный в рамках проекта.
- Дополнительно должен использоваться параметр customer_email — адрес электронной почты пользователя. Если параметр отсутствует в запросе, на Payment Page пользователю отображается поле для ввода недостающего значения. Если параметр присутствует в запросе, на Payment Page пользователю отображается поле с предварительно заполненным значением параметра, указанного в запросе, для подтверждения или изменения.
- Для предварительного выбора метода PayMaya необходимо указывать код платёжного метода в параметре force_payment_method —
paymaya-wallet
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода PayMaya должен содержать идентификаторы проекта, пользователя и платежа, валюту и сумму платежа, а также подпись:
{ payment_id: 'ECT_TEST_1547', payment_amount: 1000, payment_currency: 'PHP', project_id: 210, customer_id: 'customer1', customer_email: 'test@example.com', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+K...tT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" }
Формат оповещений
Для оповещений о результатах оплат с применением метода PayMaya используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 445
была успешно проведена оплата в размере 10,00 PHP
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 445, "payment": { "id": "EP3bc1-5a65", "type": "purchase", "status": "success", "date": "2021-06-15T08:05:11+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "" }, "account": { "number": "1234" }, "operation": { "id": 590, "type": "sale", "status": "success", "date": "2021-06-15T08:05:11+0000", "created_date": "2021-06-15T08:04:48+0000", "request_id": "c26a7ec94caf8fe7af3f280fd5e5c4-00000001", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 1797, "payment_id": "RF6XIZSW", "auth_code": "", "endpoint_id": "PYMY", "date": "2020-02-13T08:31:32+0000" } }, "signature": "wY/4RYA6R52eKohgMjdxRF9Z43Xixw27u38SGgXmq80Q==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 239, "payment": { "id": "EPfa87-bcfc", "type": "purchase", "status": "decline", "date": "2020-03-07T14:11:00+0000", "method": "PayMaya wallet", "sum": { "amount": 200000000, "currency": "PHP" }, "description": "" }, "operation": { "id": 465, "type": "sale", "status": "decline", "date": "2020-03-07T14:11:00+0000", "created_date": "2020-03-06T14:10:34+0000", "request_id": "f6ab99eb0940e43a774b8ef08eec6c8951-00000002", "sum_initial": { "amount": 200000000, "currency": "PHP" }, "sum_converted": { "amount": 200000000, "currency": "PHP" }, "code": "20101", "message": "Decline due to amount or frequency limit", "provider": { "id": 1369, "payment_id": "7QKID3P3", "auth_code": "", "date": "2020-03-06T14:10:54+0000" } }, "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob==" } }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода PayMaya со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление в сервис PayMaya.
- Принять оповещение от платежной платформы ECommPay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через PayMaya.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис PayMaya.
- На стороне PayMaya выполняется обработка запроса на оплату.
- От сервиса PayMaya к платёжной платформе передаются данные для перенаправления пользователя на сайт PayMaya.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в PayMaya в объекте redirect_data.
- Пользователь перенаправляется в сервис PayMaya.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса PayMaya выполняется обработка платежа.
- Со стороны PayMaya пользователю по электронной почте отправляется информация о результате оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса PayMaya к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом PayMaya через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода PayMaya необходимо учитывать следующее:
- Должен использоваться запрос
v2/payment/wallet/paymaya/sale
, отправляемый методом POST. Этот запрос относится к группе запросов для проведения оплат с использованием электронных кошельков /v2/payment/wallet/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции,
- payment_id — идентификатор платежа, уникальный в рамках проекта,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- email — адрес электронной почты,
- ip_address — используемый IP-адрес;
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
- success — URL для перенаправления пользователя в случае успешной оплаты,
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода PayMaya должен содержать идентификаторы проекта и платежа, валюту и сумму платежа, подпись, данные пользователя и URL для перенаправления:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 580, "payment_id": "test_paymaya_sale", "signature": "pgwRHcfv2OTsdILn33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw==" }, "payment": { "amount": 1000, "currency": "PHP" }, "customer": { "email": "test_customer@example.com", "ip_address": "1.1.1.1", "id": "123" }, "return_url": { "success": "http://example.com/success" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса PayMaya необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data": {
"body": {},
"method": "GET",
"url": "https://test.ph/Pay.aspx?tokenid=3f511c2d&procid=BITC"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода PayMaya используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 445
была успешно проведена оплата в размере 10,00 PHP
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 445, "payment": { "id": "EP3bc1-5a65", "type": "purchase", "status": "success", "date": "2021-06-15T08:05:11+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "" }, "account": { "number": "1234" }, "operation": { "id": 590, "type": "sale", "status": "success", "date": "2021-06-15T08:05:11+0000", "created_date": "2021-06-15T08:04:48+0000", "request_id": "c26a7ec94caf8fe7af3f280fd5e5c4-00000001", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 1797, "payment_id": "RF6XIZSW", "auth_code": "", "endpoint_id": "PYMY", "date": "2020-02-13T08:31:32+0000" } }, "signature": "wY/4RYA6R52eKohgMjdxRF9Z43Xixw27u38SGgXmq80Q==" }
В следующем примере оплата была отклонена:
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 239, "payment": { "id": "EPfa87-bcfc", "type": "purchase", "status": "decline", "date": "2020-03-07T14:11:00+0000", "method": "PayMaya wallet", "sum": { "amount": 200000000, "currency": "PHP" }, "description": "" }, "operation": { "id": 465, "type": "sale", "status": "decline", "date": "2020-03-07T14:11:00+0000", "created_date": "2020-03-06T14:10:34+0000", "request_id": "f6ab99eb0940e43a7a88ef08eec6c8951-00000002", "sum_initial": { "amount": 200000000, "currency": "PHP" }, "sum_converted": { "amount": 200000000, "currency": "PHP" }, "code": "20000", "message": "General decline", "provider": { "id": 1369, "payment_id": "7QKID3P3", "auth_code": "", "date": "2020-03-06T14:10:54+0000" } }, "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob==" } }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Выплаты через Gate
Общая информация
Для выплаты через Gate с использованием метода PayMaya со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате выплаты. Полная схема проведения выплаты представлена далее.
Рис.: Проведение выплаты через Gate
- Пользователь на стороне веб-сервиса инициирует выплату через PayMaya.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
- Запрос на проведение выплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис провайдера.
- На стороне провайдера выполняется обработка платежа.
- От провайдера к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат выплаты.
Информация о формате запросов и параметрах инициализации выплат методом PayMaya через Gate, а также о формате оповещений о результатах выплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на выплаты с применением метода PayMaya необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/wallet/paymaya/payout
, отправляемый методом POST. Этот запрос относится к группе запросов на выплату с помощью электронного кошелька: /v2/payment/wallet/{payment_method}/payout. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — сведения о платеже:
- amount — сумма в минорных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — сведения о пользователе:
- account — объект, содержащий сведения об учётной записи пользователя:
- number — идентификатор учётной записи, должен состоять из 11 цифр и начинаться с
09
; - customer_name — полное имя пользователя.
- number — идентификатор учётной записи, должен состоять из 11 цифр и начинаться с
- general — основные сведения:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на выплату с применением метода PayMaya должен содержать идентификаторы проекта и платежа, подпись, данные пользователя и учётной записи, валюту и сумму платежа:
Рис.: Пример запроса на выплату
{ "general": { "project_id": 603, "payment_id": "1000003", "signature": "PJkV8ej/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV...==" }, "customer": { "id": "111232323", "ip_address": "1.1.1.1" }, "payment": { "amount": 1000, "currency": "PHP" }, "account": { "number": "09123456789", "customer_name": "John Doe" } }
Формат оповещений
Для оповещений о результатах выплат с применением метода PayMaya используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 445
была успешно проведена выплата в размере 10,00 PHP
.
Рис.: Пример оповещения о проведении выплаты
{ "project_id": 445, "payment": { "id": "10615_110613_51729356", "type": "payout", "status": "success", "date": "2021-06-15T08:06:25+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "payout" }, "account": { "number": "123123" }, "customer": { "id": "1234", "phone": "09123456789" }, "operation": { "id": 592, "type": "payout", "status": "success", "date": "2021-06-15T08:06:25+0000", "created_date": "2021-06-15T08:06:14+0000", "request_id": "bdec3c53155f87d1f59c0e16043cf7c9a-00000001", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 1994, "payment_id": "RS2PHYOBG5", "auth_code": "", "endpoint_id": "GRPY", "date": "2021-06-15T00:06:24+0000" } }, "signature": "xndoWc28knuz24ZeVBdQadwSRXgPYIDqN/M3ZOEYI7A==" }
В следующем примере выплата была отклонена.
Рис.: Пример оповещения об отказе в проведении выплаты
{ "project_id": 445, "payment": { "id": "10615_110613_51729357", "type": "payout", "status": "decline", "date": "2021-06-15T08:07:25+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "payout" }, "account": { "number": "123123" }, "customer": { "id": "1234", "phone": "09123456789" }, "operation": { "id": 592, "type": "payout", "status": "decline", "date": "2021-06-15T08:06:25+0000", "created_date": "2021-06-15T08:06:14+0000", "request_id": "bdec3c53155f87d1f59c0e16043cf7c9a-00000002", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "20000", "message": "General decline", "provider": { "id": 1994, "payment_id": "RS2PHYOBG6", "auth_code": "", "endpoint_id": "GRPY", "date": "2021-06-15T00:06:24+0000" } }, "signature": "xndoWc28knuz24ZeVBdQadwSRXgPYIDqN/M3ZOEYI6A==" }
Дополнительные материалы
Для организации работы с выплатами через Gate также могут быть полезны следующие материалы:
Выплаты через Dashboard
- как единичную выплату — в этом случае для каждой выплаты необходимо указать доступные для данного метода валюту и сумму, выбрать метод и заполнить все поля, отображаемые в интерфейсе с учётом выбранного метода;
- в рамках массового платежа — в этом случае все параметры выплат необходимо задать в файле формата CSV с учётом требований, представленных в разделе Выплаты через Gate (кроме пункта о подписи).
Информация о проведении выплат отображается в разделах Платежи и Мануальные платежи интерфейса Dashboard.
Более подробная информация о проведении выплат через Dashboard представлена в разделе Проведение выплат.
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода PayMaya доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.