Sofort

Обзор

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

Прим.:

Для работы с методом Sofort в настоящее время поддерживается два варианта: новый, описанный в данном разделе, и старый, описанный в разделе Sofort (legacy).

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

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

Тип платёжного метода банковские платежи
Платёжные инструменты
  • банковские счета
  • платёжные карты
Регионы использования AT, BE, DE, ES, IT, NL
Валюты платежей EUR
Конвертация валют на стороне ecommpay
Оплаты +
Выплаты
Оплаты по сохранённым данным
Полные возвраты +
Частичные возвраты +
Опротестования
Особенности
  • при проведении оплат может использоваться процедура получения подтверждения о зачислении средств, для её подключения необходимо обращаться к курирующему менеджеру ecommpay
  • для выполнения возвратов необходимо обращаться к курирующему менеджеру ecommpay
Организация и стоимость подключения по согласованию с курирующим менеджером ecommpay

Схема работы

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



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

Для проведения оплат с использованием метода Sofort применяются интерфейсы Gate и Payment Page, при этом ограничения по суммам и времени выполнения операций зависят от банков, поддерживающих оплату этим методом.

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

Оплаты с использованием метода Sofort проводятся с перенаправлением пользователей к сервису Sofort. При этом для оплат могут использоваться два варианта: с подтверждением зачисления средств на счёт получателя и без подтверждения. Такие подтверждения могут быть полезны при работе с некоторыми банками, поскольку обработка платежей на стороне сервиса Sofort и этих банков может занимать продолжительное время (до семи дней и больше) и первичные подтверждения о проведении платежей впоследствии могут опровергаться.

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

Подтверждение зачисления средств

В проведении оплат с использованием метода Sofort могут участвовать банки, и в некоторых случаях обработка платежей на стороне этих банков и сервиса Sofort может занимать продолжительное время (до семи дней и больше). В связи с этим возможны ситуации, когда первичная информация о проведении или отклонении платежа не соответствует итоговому результату (например, при получении информации об отклонении платежа средства могут быть зачислены на счёт получателя позднее, и наоборот).

Чтобы обеспечить корректное уведомление мерчантов о состоянии платежей в таких случаях, в платёжной платформе ecommpay используется процедура подтверждения зачисления средств получателю. При подключении метода Sofort следует согласовывать с курирующим менеджером использование этой процедуры, а также перевод платежей, по которым получено подтверждение о том, что средства не зачислены, в статус reversed или decline (для удобства контроля и анализа платежей).

Подтверждение зачисления средств выполняется следующим образом: после выполнения пользователем всех необходимых действий платёж поступает в обработку на стороне сервиса Sofort, а пользователь возвращается к платёжному интерфейсу (Payment Page или веб-сервиса), где получает информацию о приёме платежа в обработку. В таком случае на стороне платёжной платформы формируется операция payment confirmation, при этом платежу присваивается статус awaiting confirmation до получения со стороны сервисного провайдера информации о зачислении средств и к веб-сервису отправляется соответствующее оповещение о состоянии платежа.

По итогам выполнения операции payment confirmation ей может присваиваться один из следующих статусов:

  • success — при получении подтверждения со стороны сервисного провайдера о зачислении средств получателю. В этом случае платежу присваивается статус success и к веб-сервису отправляется итоговое оповещение с информацией о результате оплаты.
  • decline — при получении информации со стороны сервисного провайдера о том, что средства не зачислены получателю. В этом случае, с учётом свойств проекта, заданных при подключении, допустимы следующие сценарии:
    • На стороне платёжной платформы автоматически формируется операция reversal и к веб-сервису последовательно отправляются соответствующие оповещения: промежуточное, с информацией о том, что средства не были зачислены, и итоговое, с информацией о возврате средств и переводе платежа в статус reversed.
    • Платёж переводится в статус decline и к веб-сервису направляется итоговое оповещение с информацией об отклонении оплаты.

Контролировать изменение статусов платежей при использовании этой процедуры также можно через интерфейс Dashboard.

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

Оплаты через 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 с подтверждением зачисления средств. Описание шагов

  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. Пользователь перенаправляется к Payment Page.
  17. От сервиса Sofort к платёжной платформе направляется уведомление о состоянии платежа.
  18. От платёжной платформы к веб-сервису направляется оповещение о состоянии платежа.
  19. От платёжной платформы к веб-сервису передаётся информация об обработке платежа на стороне сервиса Sofort.
  20. Пользователю на Payment Page отображается информация об обработке платежа на стороне сервиса Sofort.
  21. После получения информации о зачислении средств получателю от сервиса Sofort к платёжной платформе направляется информация о результате оплаты.
  22. От платёжной платформы к веб-сервису направляется оповещение с информацией о результате оплаты.

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

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

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

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

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

{ 
      project_id: 8791,   
      payment_id: 'B436', 
      customer_id: 'customer123',
      payment_currency: 'EUR', 
      payment_amount: 10000,  
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KUDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

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

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

Рис.: Пример данных из оповещения о проведении оплаты (без подтверждения зачисления средств)

 {
        "project_id": 8791,
        "payment": {
            "id": "test_02",
            "type": "purchase",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "payment_02"
        },
        "account": {
            "number": "2300568"
        },
        "operation": {
            "id": 141539000182,
            "type": "sale",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "created_date": "2022-02-19T14:25:24+0000",
            "request_id": "9d22c3bad2913b488"
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 11339,
                "payment_id": "1228",
                "date": "2022-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBRh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

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

{
        "project_id": 8791,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "TEST_154996174000"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 9172000183,
            "type": "sale",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "created_date": "2022-02-12T10:56:18+0000",
            "request_id": "11d4a9cb74c0681927ad7",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1100,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "n/1oVdS/mE0AlVOUDbbNqasdfghjiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

Рис.: Пример данных из оповещения о состоянии платежа (с подтверждением зачисления средств)

{
        "project_id": 8792,
        "payment": {
            "id": "E4364-fc4d",
            "type": "purchase",
            "status": "awaiting confirmation", // статус платежа
            "date": "2022-04-12T08:46:13+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "DE06000123456789"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 77,
            "type": "payment confirmation",
            "status": "success",
            "date": "2022-04-12T08:46:13+0000",
            "created_date": "2022-04-12T08:45:01+0000",
            "request_id": "935948575ce85f651ac81f6c412c205eee9a01f0-00000001",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 15203,
                "payment_id": "212225-7590-6710",
                "auth_code": "",
                "endpoint_id": "TD0XXX",
                "date": "2022-04-12T08:45:29+0000"
            }
        },
        "signature": "AvFBWWqia+EItai8yr7yLWl+24bRAouEm59YzlMCUxl/Dhlw5QRFpw5+Q=="
    }

Рис.: Пример данных о проведении оплаты (с подтверждением зачисления средств)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_5524",
            "type": "purchase",
            "status": "success",    // итоговый статус платежа
            "date": "2022-07-18T07:36:19+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_5524"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 55221,
            "type": "sale",
            "status": "success",
            "date": "2022-07-18T07:36:19+0000",
            "created_date": "2022-07-18T07:33:01+0000",
            "request_id": "a0dd90bd188cc93104d8776f3f23ff66-00023585...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 9491,
                "payment_id": "212BAB0",
                "auth_code": "",
                "endpoint_id": "ABCXXX",
                "date": "2022-07-18T07:36:13+0000"
            }
        },
        "signature": "RVbY4YUVF0a+K28YPr2//P+mPht24BjO9lPWvRLla4Bic5KdiRg=="
}

Рис.: Пример данных из оповещения с информацией о том, что средства не зачислены

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6617",
            "type": "purchase",
            "status": "awaiting confirmation",    // статус платежа
            "date": "2022-07-18T07:51:24+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_6617"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 10103681,
            "type": "payment confirmation", 
            "status": "decline",    // подтверждение того, что средства не зачислены
            "date": "2022-07-18T07:52:25+0000",
            "created_date": "2022-07-18T07:51:24+0000",
            "request_id": "752d-7aac86523ffcc8f19bab54b1e93c14...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 0123,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "RRBu5U1woawhuYXdpf5lHB6OEsp9SGuiJI3AWvOXhKqtw=="
    }

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

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6017",
            "type": "purchase",
            "status": "reversed",    // статус платежа
            "date": "2022-07-18T07:52:27+0000",
            "method": "sofort",
            "sum": {
                "amount": 0,
                "currency": "EUR"
            },
            "description": "PAYMENT_6017"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 2010691,
            "type": "reversal",
            "status": "success",
            "date": "2022-07-18T07:52:27+0000",
            "created_date": "2022-07-18T07:52:26+0000",
            "request_id": "a4037d3ce2d1812c1-45c98e4898e2854a1325-00086743...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2345,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "LcsU5RU0LiHfP5Sc/6LVxMt5+Q8w21RGUZehQW0SpHt1VpB7MmV8bg=="
    }

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

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

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

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

Схема проведения оплаты через Gate с использованием метода Sofort зависит от использования процедуры подтверждения о зачислении средств. В общем случае для оплаты через 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. От веб-сервиса пользователю направляется результат оплаты.


Рис.: Проведение оплаты через 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. От сервиса Sofort к платёжной платформе направляется уведомление о состоянии платежа.
  15. От платёжной платформы к веб-сервису направляется оповещение о состоянии платежа.
  16. От веб-сервиса пользователю направляется информация о приёме платежа в обработку на стороне сервиса Sofort.
  17. После получения информации о зачислении средств от сервиса Sofort к платёжной платформе направляется информация о результате оплаты.
  18. От платёжной платформы к веб-сервису направляется оповещение с информацией о результате оплаты.

Информация о формате запросов и параметрах инициирования оплат с использованием метода 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 — идентификатор проекта,
      • ip_address — используемый IP-адрес;
    • payment — сведения о платеже:
      • amount — сумма платежа в дробных единицах,
      • currency — код валюты платежа в формате ISO-4217 alpha-3.
  3. Валютой платежа может быть только EUR.
  4. Дополнительно могут использоваться другие параметры, указанные в спецификации.

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

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

{
    "general": {
        "project_id": 2390,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "id": "customer_1",
      "ip_address": "127.0.0.1"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    }
}

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

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

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

"redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://sofort.com/payment/9X4AP1vj&cs=13073..."
                }

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

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

Рис.: Пример данных из оповещения о проведении оплаты (без подтверждения зачисления средств)

 {
        "project_id": 8791,
        "payment": {
            "id": "test_02",
            "type": "purchase",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "payment_02"
        },
        "account": {
            "number": "2300568"
        },
        "operation": {
            "id": 141539000182,
            "type": "sale",
            "status": "success",
            "date": "2022-02-19T14:25:25+0000",
            "created_date": "2022-02-19T14:25:24+0000",
            "request_id": "9d22c3bad2913b488"
                "amount": 10000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 11339,
                "payment_id": "1228",
                "date": "2022-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "of8k9xerKSKpFBRh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
    }

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

{
        "project_id": 8791,
        "payment": {
            "id": "TEST_154996862174000",
            "type": "purchase",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": "TEST_154996174000"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 9172000183,
            "type": "sale",
            "status": "decline",
            "date": "2022-02-12T10:56:22+0000",
            "created_date": "2022-02-12T10:56:18+0000",
            "request_id": "11d4a9cb74c0681927ad7",
            "sum_initial": {
                "amount": 10000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1100,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "n/1oVdS/mE0AlVOUDbbNqasdfghjiRz0yJRrqn7HiBOEIObz2tN5SLw=="
    }
}

Рис.: Пример данных из оповещения о состоянии платежа (с подтверждением зачисления средств)

{
        "project_id": 8792,
        "payment": {
            "id": "E4364-fc4d",
            "type": "purchase",
            "status": "awaiting confirmation", // статус платежа
            "date": "2022-04-12T08:46:13+0000",
            "method": "sofort",
            "sum": {
                "amount": 10000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "DE06000123456789"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 77,
            "type": "payment confirmation",
            "status": "success",
            "date": "2022-04-12T08:46:13+0000",
            "created_date": "2022-04-12T08:45:01+0000",
            "request_id": "935948575ce85f651ac81f6c412c205eee9a01f0-00000001",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 15203,
                "payment_id": "212225-7590-6710",
                "auth_code": "",
                "endpoint_id": "TD0XXX",
                "date": "2022-04-12T08:45:29+0000"
            }
        },
        "signature": "AvFBWWqia+EItai8yr7yLWl+24bRAouEm59YzlMCUxl/Dhlw5QRFpw5+Q=="
    }

Рис.: Пример данных о проведении оплаты (с подтверждением зачисления средств)

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_5524",
            "type": "purchase",
            "status": "success",    // итоговый статус платежа
            "date": "2022-07-18T07:36:19+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_5524"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 55221,
            "type": "sale",
            "status": "success",
            "date": "2022-07-18T07:36:19+0000",
            "created_date": "2022-07-18T07:33:01+0000",
            "request_id": "a0dd90bd188cc93104d8776f3f23ff66-00023585...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 9491,
                "payment_id": "212BAB0",
                "auth_code": "",
                "endpoint_id": "ABCXXX",
                "date": "2022-07-18T07:36:13+0000"
            }
        },
        "signature": "RVbY4YUVF0a+K28YPr2//P+mPht24BjO9lPWvRLla4Bic5KdiRg=="
}

Рис.: Пример данных из оповещения с информацией о том, что средства не зачислены

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6617",
            "type": "purchase",
            "status": "awaiting confirmation",    // статус платежа
            "date": "2022-07-18T07:51:24+0000",
            "method": "sofort",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "PAYMENT_6617"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 10103681,
            "type": "payment confirmation", 
            "status": "decline",    // подтверждение того, что средства не зачислены
            "date": "2022-07-18T07:52:25+0000",
            "created_date": "2022-07-18T07:51:24+0000",
            "request_id": "752d-7aac86523ffcc8f19bab54b1e93c14...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 0123,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "RRBu5U1woawhuYXdpf5lHB6OEsp9SGuiJI3AWvOXhKqtw=="
    }

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

{
        "project_id": 8792,
        "payment": {
            "id": "PAYMENT_6017",
            "type": "purchase",
            "status": "reversed",    // статус платежа
            "date": "2022-07-18T07:52:27+0000",
            "method": "sofort",
            "sum": {
                "amount": 0,
                "currency": "EUR"
            },
            "description": "PAYMENT_6017"
        },
        "customer": {
            "id": "customer123"
        },
        "account": {
            "number": "DE0123456789"
        },
        "operation": {
            "id": 2010691,
            "type": "reversal",
            "status": "success",
            "date": "2022-07-18T07:52:27+0000",
            "created_date": "2022-07-18T07:52:26+0000",
            "request_id": "a4037d3ce2d1812c1-45c98e4898e2854a1325-00086743...",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2345,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "LcsU5RU0LiHfP5Sc/6LVxMt5+Q8w21RGUZehQW0SpHt1VpB7MmV8bg=="
    }

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

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

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

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

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

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

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

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