EPay

Обзор

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

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

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

Схема работы

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



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

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

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

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

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



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



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

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

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

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



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

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

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

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

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

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

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

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

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 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": "bfe58066b0f4331c",
            "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+RRAvAzF7aCMYHvoEsQjZf8DrBR1xHVlAzfdNHgUEJe4POy6ZpkEQ=="
    }
}

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

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

{
        "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": "20000",
            "message": "General decline"
        },
        "signature": "3nAGOrfkfY/+VqUqhSVkRDfaTgja8pDzQKSzpMh6eVE7ipxDRNz1IO4AxA3A=="
    }
}

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

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

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

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

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

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

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



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

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

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

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

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

  1. Должен использоваться запрос /v2/payment/cash/epay/sale , отправляемый методом POST. Этот запрос относится к группе запросов для проведения оплаты с помощью наличных /v2/payment/cash/{payment_method}/sale.
  2. В запросе должны использоваться следующие объекты и параметры:
    • 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 — описание или комментарий к платежу.
  3. Валютой платежа может быть только MYR.
  4. Дополнительно могут использоваться все параметры, указанные в спецификации.

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

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

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

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

Для завершения оплаты необходимо отобразить пользователям инструкцию по оплате. Для передачи данных (штрихкода, QR-кода, и пр.) пользователям ввиде инструкции необходимо принять оповещение от платёжной платформы, содержащее объект redirect_data с необходимыми данными в теле redirect_data.body:
  • reference_number — номер (идентификатор) для совершения оплаты,
  • valid_time — время, до которого необходимо завершить платеж,
  • user_name — имя пользователя, совершающего платеж.

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

"redirect_data": {
                    "body": {
                      "reference_number": "045-050-000",
                      "valid_time": "2019-06-15 14:17:26",
                      "user_name": "THANAPAT JISAMANYA"
                    },
                    "method": "GET",
                    "url": "https://onlinepayment.epay.com"
                }

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 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": "20000",
            "message": "General decline"
        },
        "signature": "3nAGOrfkfY/+VqUqhSVkzpMh6eVE7ipxDRNz1IO4AxA3A=="
    }
}

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

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

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

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

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

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

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

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