Sofort

Обзор

Sofort — альтернативный платёжный метод для проведения оплат и возвратов с использованием интернет-банкинга. Оплаты осуществляются через Payment Page и Gate, возвраты — через Gate.

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

Тип платёжного метода Интернет-банкинг
Регионы использования AT, BE, CH, DE, ES, GB, IT, NL, PL
Валюты платежей EUR, GBP, PLN *
Конвертация валют на стороне ECommPay
Оплаты +
Выплаты
Оплаты по сохранённым данным
Полные возвраты +
Частичные возвраты +
Опротестования
Особенности
Организация и стоимость подключения По согласованию с курирующим менеджером ECommPay
* Точную информацию уточняйте у курирующего менеджера ECommPay.

Схема работы

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



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

Интерфейсы Суммы, EUR
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) минимум максимум
Оплаты + 1,00 5 000,00 *
Полные возвраты +
Частичные возвраты +

* По согласованию с курирующим менеджером ECommPay.

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

Проведение оплат с использованием метода Sofort выполняется с перенаправлением пользователей к сервису Sofort, проведение возвратов — с заявкой от пользователей через веб-сервис мерчанта и уведомлением о поступлении средств на счет.

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



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



Рис.: Возврат через Gate



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

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

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

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



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

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

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

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

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

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

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'EUR', 
      project_id: 239,    
      customer_id: 'customer123',
      customer_first_name: 'John',
      customer_last_name: 'Johnson',
      customer_email: 'johnson@mail.com',
      customer_country: 'DE',
      language_code: de,  
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

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

 {
        "project_id": 238,
        "payment": {
            "id": "test_02",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "payment_02"
        },
        "account": {
            "number": "2626324568"
        },
        "operation": {
            "id": 14153000003282,
            "type": "sale",
            "status": "success",
            "date": "2019-02-19T14:25:25+0000",
            "created_date": "2019-02-19T14:25:24+0000",
            "request_id": "9d11b2ca618ec3bad2913b488"
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1169,
                "payment_id": "105887607",
                "date": "2019-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBR4XL1QFaDRbOmstt9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

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

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

{
        "project_id": 238,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "USD"
            },
            "description": "TEST_154996862174000"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 9172000003183,
            "type": "sale",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "created_date": "2019-02-12T10:56:18+0000",
            "request_id": "11d4aabf869cb74c0681927ad7",
            "sum_initial": {
                "amount": 100,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 88,
                "currency": "EUR"
            },
            "provider": {
                "id": 1169,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "n/1oVdS/mE0AlVOUDbbNqasdfghjm/jmhngfdsxeI14MBiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cVHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "id": "1customer1",
      "ip_address": "1.1.1.1",
      "first_name": "John",
      "last_name": "Johnson",
      "email": "johnson@mail.com",
      "country": "DE"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://merchantsite.com"
    }
}

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

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

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

"redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://t2sofort?tx=478011136&rs=a9X4A17Zp260P1vj&cs=13073"
                }

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

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

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

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

 {
        "project_id": 238,
        "payment": {
            "id": "test_02",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "payment_02"
        },
        "account": {
            "number": "2626324568"
        },
        "operation": {
            "id": 14153000003282,
            "type": "sale",
            "status": "success",
            "date": "2019-02-19T14:25:25+0000",
            "created_date": "2019-02-19T14:25:24+0000",
            "request_id": "9d11b2ca618ec3bad2913b488"
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1169,
                "payment_id": "105887607",
                "date": "2019-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBR4XL1QFaDRbOmstt9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

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

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

{
        "project_id": 238,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "USD"
            },
            "description": "TEST_154996862174000"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 9172000003183,
            "type": "sale",
            "status": "decline",
            "date": "2019-02-12T10:56:22+0000",
            "created_date": "2019-02-12T10:56:18+0000",
            "request_id": "11d4aabf869cb74c0681927ad7",
            "sum_initial": {
                "amount": 100,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 88,
                "currency": "EUR"
            },
            "provider": {
                "id": 1169,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "n/1oVdS/mE0AlVOUDbbNqasdfghjm/jmhngfdsxeI14MBiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

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

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

Возвраты через Gate

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

Sofort поддерживает проведение полных и частичных возвратов через Gate следующим способом: со стороны веб-сервиса мерчанта необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay, и принять оповещение о результате возврата. Полная схема проведения возврата представлена далее.



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

  1. Пользователь запрашивает возврат средств в веб-сервисе.
  2. От веб-сервиса мерчанта на заданный URL ECommPay передаётся запрос на проведение возврата через Gate.
  3. Gate перенаправляет запрос в платёжную платформу ECommPay для дальнейшей обработки.
  4. На стороне платёжной платформы ECommPay выполняются необходимые проверка и первичная обработка запроса.
  5. От платёжной платформы в веб-сервис передается ответ с результатом первичной обработки запроса. Подробнее см. в разделе Формат ответа.
  6. Обработанный запрос передается в сервис Sofort.
  7. На стороне Sofort выполняется обработка платежа.
  8. От Sofort к платёжной платформе ECommPay направляется оповещение о результате.
  9. От платёжной платформы ECommPay к веб-сервису направляется оповещение о результате.
  10. Пользователь получает информацию о поступлении запрошенных средств (в соответствии с порядком работы веб-сервиса).

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

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

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

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

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

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

  "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
  },  
    "customer": {    
     "ip_address": "1.2.3.4" 
 },  
    "payment": {    
     "amount": 10000,    
     "currency": "EUR",
     "description": "refund_02"
}
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 238 для пользователя был успешно проведён возврат в размере 100,00 EUR на счёт № 2626324568.

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

{
        "project_id": 238,
        "payment": {
            "id": "refund_02",
            "type": "purchase",
            "status": "refunded",
            "date": "2019-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "test_02"
        },
        "account": {
            "number": "2626324568"
        },
        "operation": {
            "id": 14153000003282,
            "type": "refund",
            "status": "success",
            "date": "2019-02-19T14:25:25+0000",
            "created_date": "2019-02-19T14:25:24+0000",
            "request_id": "9d11b2ca618ec3ba0f588af8af3c4fc9f5fa58f174",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1169,
                "payment_id": "105887607",
                "date": "2019-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

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

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

{
        "project_id": 238,
        "payment": {
            "id": "refund_02",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 100000,
                "currency": "EUR"
            },
            "description": "test_02"
        },
        "account": {
            "number": "2626324568"
        },
        "operation": {
            "id": 14153000003282,
            "type": "refund",
            "status": "decline",
            "date": "2019-02-19T14:25:25+0000",
            "created_date": "2019-02-19T14:25:24+0000",
            "request_id": "9d11b2ca618ec3ba0f588af8af3c4fc9f5fa58f174",
            "sum_initial": {
                "amount": 100000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1169,
                "payment_id": "105887607",
                "date": "2019-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
        },
        "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

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

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

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

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

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

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

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

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