Neosurf

Обзор

Neosurf — платёжный метод для проведения оплат с использованием электронного кошелька Neosurf, а также для оплат с использованием ваучеров. Для работы с этим методом доступно проведение оплат через Payment Page и Gate.

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

Тип платёжного метода
  • платежи с использованием электронных кошельков
  • платежи с использованием ваучеров
Регионы использования AU, CA, AT, BE, CY, FR, IE, LU, NL, PL, PT, RO, ES, GB, BJ, BF, BI, CM, CF, CD, CG, GQ, GA, GM, GW, GN, CI, KE, MW, ML, MR, MA, MZ, NE, NG, NZ, RW, ST, SN, SL, TZ, TG, UG, ZM, ZW
Валюты платежей AUD, BGN, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HRK, HUF, ILS, INR, MXN, MYR, NOK, NZD, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, USD, ZAR
Конвертация валют
Оплаты +
Выплаты
Оплаты по сохранённым данным
Полные возвраты
Частичные возвраты
Опротестования
Особенности
Организация и стоимость подключения по согласованию с курирующим менеджером ECommPay

Схема работы

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



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

Интерфейсы Суммы в поддерживаемых валютах Время *
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) Минимум Максимум базовое предельное
Оплаты + + 0,01 1 000 000,00 22 часа

* Базовое и предельное время определяются следующим образом:

  • Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
  • Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус decline. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.

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

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

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



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



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

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

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

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



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

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

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

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

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

  1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
    • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
    • payment_id — идентификатор платежа уникальный в рамках проекта;
    • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
    • payment_amount — сумма платежа в минорных единицах;
    • customer_id — идентификатор пользователя уникальный в рамках проекта.
  2. Для предварительного выбора метода Neosurf необходимо указывать код платёжного метода в параметре force_payment_methodneosurf.
  3. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  4. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

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

    { 
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'EUR', 
      project_id: 0, 
      signature: "kUi2x9dKHAVNU0FYldJrxh4U...CUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_900898",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "test payment"
        },
        "customer": {
            "id": "100"
        },
        "operation": {
            "id": 5042576000000972,
            "type": "sale",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "created_date": "2020-08-03T11:04:08+0000",
            "request_id": "348238e315dad344ea02dade1a144599...440994063c-05042577",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 3201,
                "payment_id": "109726234",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-08-03T11:05:11+0000"
            }
        },
        "signature": "jYsUJ/r8GFOxPglW5GTstB9fyb7Lk2VC4...UBf+/zn8jQmj7WH2w0+EQ=="
    }

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

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

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_178551",
            "type": "purchase",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 200,
                "currency": "EUR"
            },
            "description": "test decline"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 86491000000461,
            "type": "sale",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "created_date": "2020-07-30T07:26:32+0000",
            "request_id": "a072079ed4a08a0d4d3d13d336b77a...a802115007c9a-00086492",
            "sum_initial": {
                "amount": 200,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 3201,
                "payment_id": "109689003",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-07-31T11:32:11+0000"
            }
        },
        "signature": "pjZAPbO9+zieWV7l5A49YIpAaQ7H...O67CTG/TUYd72zS8uArr0BZZQfQ=="
    }

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

{
    "general": {
    "project_id": 125,
    "payment_id": "ECP_TEST_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV+VHq3L
                        wY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
  },
  "customer": {
    "ip_address": "112.56.98.67"
    "id": "123"
    },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
  }
}

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

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

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

"redirect_data": {
    "url": "https://pay.neosurf.com",
    "method": "POST",
    "body": {         
            "amount": 100,           
            "currency": "eur",
            "hash": "fsdffr456rlk44rh34vrwf923vfvsnf",
            "language": "en",
            "merchantId": 12123324546,
            "merchantTransactionId": "23423435345656",
            "prohibitedForMinors": "no",
            "subMerchantId": "https://www.shop.mywebsite.com",
            "test": "no",
            "urlOk": "http://time.net/?type=good",
            "urlKo": "http://time.net/?type=no",
            "urlPending": "http://time.net/?type=waiting",
            "urlCallback": "http://time.net/?type=callback",
            "version": 3
    }
  }

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

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

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

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

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_900898",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "test payment"
        },
        "customer": {
            "id": "100"
        },
        "operation": {
            "id": 5042576000000972,
            "type": "sale",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "created_date": "2020-08-03T11:04:08+0000",
            "request_id": "348238e315dad344ea02dade1a144599...440994063c-05042577",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 3201,
                "payment_id": "109726234",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-08-03T11:05:11+0000"
            }
        },
        "signature": "jYsUJ/r8GFOxPglW5GTstB9fyb7Lk2VC4...UBf+/zn8jQmj7WH2w0+EQ=="
    }

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

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

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_178551",
            "type": "purchase",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 200,
                "currency": "EUR"
            },
            "description": "test decline"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 86491000000461,
            "type": "sale",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "created_date": "2020-07-30T07:26:32+0000",
            "request_id": "a072079ed4a08a0d4d3d13d336b77a...a802115007c9a-00086492",
            "sum_initial": {
                "amount": 200,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 3201,
                "payment_id": "109689003",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-07-31T11:32:11+0000"
            }
        },
        "signature": "pjZAPbO9+zieWV7l5A49YIpAaQ7H...O67CTG/TUYd72zS8uArr0BZZQfQ=="
    }

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

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

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

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

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

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

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

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