Open Banking in the UK

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

Схема работы

В проведении отдельного платежа с использованием Open Banking in the UK задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства банка.

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

* Ограничения сумм и время проведения платежей зависят от банков.

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

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

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

Проведение оплат с использованием метода Open Banking in the UK выполняется с перенаправлением пользователей к сервису банка.

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

Рис.: Переход к оплате

Рис.: Выбор метода

Рис.: Выбор банка

Рис.: Предоставление согласия

Рис.: Аутентификация

Рис.: Подтверждение платежа

Рис.: Возвращение к форме

Рис.: Возвращение к веб-сервису

Поддержка со стороны банков

Проведение оплат с применением метода Open Banking in the UK осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании оплат через Gate, а также при вызове Payment Page для отображения страницы с выбором метода оплаты.

Далее в таблице в ознакомительных целях представлена информация об этих банках, которую следует уточнять у курирующего менеджера ecommpay или по запросу /v2/info/banks/uk/sale/list, отправляемым методом POST через Gate API: /v2/info/banks/{payment_method}/{operationType}/list для уточнения списка банков, поддерживающих проведение оплат.

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

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "GBP"
  }
}

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

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

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

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

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

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

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

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

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

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

При работе с методом Open Banking in the UK требуется получение дополнительного согласия пользователя на проведение платежа с использованием этого метода. Для получения этого согласия на Payment Page отображается соответствующая страница, на которой также могут отображаться поля для ввода дополнительных данных, необходимых для проведения платежа.

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

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

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

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

1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
   • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа в дробных единицах;
   • customer_id — идентификатор пользователя уникальный в рамках проекта.
2. Дополнительно рекомендуется указывать имя и фамилию пользователя в параметрах customer_first_name и customer_last_name. Если какой-либо из этих параметров отсутствует в запросе, на пользователю отображаются поля для ввода недостающих значений. Подробнее об уточнении параметров — в разделе Дополнение информации о платежах.

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

3. Рекомендуется передавать в запросе параметр merchant_return_url с указанием URL для перенаправления пользователя к веб-сервису, чтобы в случае отказа от предоставления согласия пользователь мог вернуться к веб-сервису мерчанта, щёлкнув соответствующую кнопку в платёжной форме. При этом, во избежание повторного оформления заказа на стороне веб-сервиса, рекомендуется указать тот адрес, который ведёт на страницу подтверждения заказа.
4. Валютой платежа может быть только GBP.
5. Для предварительного выбора группы методов Open Banking необходимо указывать код группы openbanking в параметре force_payment_group.

6. При использовании платёжного метода Open Banking in the UK можно настраивать отображение страницы Payment Page с выбором метода оплаты.

   По умолчанию банки, поддерживающие проведение оплат методом Open Banking in the UK, объединены в группу и отображаются одной кнопкой Open Banking in the UK, поэтому выбор банка осуществляется в два этапа. Сначала выбирается метод Open Banking in the UK среди прочих, а затем на следующей странице с перечнем банков выбирается конкретный банк. Существует несколько вариантов отображения страницы Payment Page с выбором метода оплаты:

   • Отображение поддерживаемых банков одной кнопкой UK Banks среди прочих методов.
   • Отображение только поддерживаемых банков одной кнопкой UK Banks. Для этого используется предварительный выбор метода Open Banking in the UK. Необходимо передавать код платежного метода uk в параметре force_payment_method. Пользователю открывается страница с выбором банков.
   • Отображение каждого поддерживаемого банка отдельной кнопкой. Для этого необходимо передавать параметр split_banks со значением true в строке payment_methods_options.

     "payment_methods_options": "{\"uk\": {\"split_banks\": true}}"
     

   • Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Open Banking in the UK. Для этого используется предварительный выбор метода Open Banking in the UK, но с указанием конкретного банка. Для этого необходимо передавать код платежного метода uk в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом.

     "payment_methods_options": "{\"uk\": {\"split_banks\": true, \"banks_id\": [3771, 3781]}}"

     Далее представлен пример запроса на открытие Payment Page с предварительно выбранным банком.

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

         { payment_id: 'X03936', 
           payment_amount: 1000, 
           payment_currency: 'GBP', 
           project_id: 120,
           customer_id: 'customer1',
           customer_first_name: 'John',
           customer_last_name: 'Doe',
           force_payment_method: 'uk',
           payment_methods_options: '{\"uk\": {\"banks_id\": [3771]}}',
           signature: "kUi2x9dKHAVNU0FYlSCQ9vySO\/...tVUkDJrOpZhkIQg=="
         }

7. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
8. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

Таким образом, корректный запрос на открытие платёжной формы с применением метода Open Banking in the UK должен содержать идентификаторы пользователя, проекта и платежа, сумму и валюту платежа, информацию о пользователе, URL для перенаправления пользователя к веб-сервису, а также подпись:

    { 
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'GBP', 
      project_id: 123, 
      customer_id: 'customer1',
      customer_first_name: 'John',
      customer_last_name: 'Doe',
      merchant_return_url: 'http://example.com/return',
      signature: "kUi2x9dKHA...\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

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

Для оповещений о результатах оплат с применением метода Open Banking in the UK используется типовой формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 239 была проведена оплата в размере 10,00 GBP.

{
   "project_id":239,
   "payment":{
      "id":"ID_461239",
      "type":"purchase",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "method":"UK banks",
      "sum":{
         "amount":1000,
         "currency":"GBP"
      },
      "description":"ID_461239"
   },
   "customer":{
      "id":"1"
   },
   "operation":{
      "id":59043000050811,
      "type":"sale",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "created_date":"2020-06-15T14:51:35+0000",
      "request_id":"929c6911448765aedaf4df...79aa8d4adb6b78dc5-00059044",
      "sum_initial":{
         "amount":1000,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":1000,
         "currency":"GBP"
      },
      "code":"0",
      "message":"Success",
      "provider":{
         "id":2901,
         "payment_id":"385dc36c-7fac-4bf5-a0e6-6a16ebcc1962",
         "auth_code":"",
         "endpoint_id":"Halifax",
         "date":"2020-06-15T14:51:36+0000"
      }
   },
   "signature":"+KDWbziHMNDBSd2Y04Cc...xRb55AnjtvrZc4XgG6iXkJyLHPa3ZbYw=="
}

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

{
   "customer":{
      "id":"1"
   },
   "project_id":10801,
   "payment":{
      "id":"ID_542650",
      "type":"purchase",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "method":"UK banks",
      "sum":{
         "amount":100,
         "currency":"GBP"
      },
      "description":"ID_542650"
   },
   "operation":{
      "id":58778000050861,
      "type":"sale",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "created_date":"2020-06-15T11:36:39+0000",
      "request_id":"e6cb17dd0699001b813a0...6753e4dca478c7eb6-00058779",
      "sum_initial":{
         "amount":100,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":100,
         "currency":"GBP"
      },
      "code":"20000",
      "message":"General decline",
      "provider":{
         "id":2901,
         "payment_id":"BARCLAYS-P-10000000420474",
         "auth_code":"",
         "endpoint_id":"Barclays",
         "date":"2020-06-15T11:36:41+0000"
      }
   },
   "signature":"kC6wuur3Q2Dswd7A6R+C...1EaupyvFHs6q/aZ7lW17cUuFhXjHoVWbrTJqQ=="
}

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

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

• Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
• Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Разовая оплата в одну стадию — о том, как проводить разовые оплаты через Payment Page.
• Информация о выполнении операций — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.

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

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

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

При работе с методом Open Banking in the UK требуется получение дополнительного согласия пользователя на проведение платежа с использованием этого метода. Информация о том, что необходимо сделать со стороны веб-сервиса для получения согласия пользователя, представлена в разделе Форматы данных для получения согласия пользователей, а далее приведена полная схема проведения оплаты.

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

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

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

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

1. Должен использоваться запрос к конечной точке /v2/payment/banks/uk/sale, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в дробных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3;
   • customer — сведения о пользователе:
     • id — идентификатор, уникальный в рамках проекта,
     • ip_address — используемый IP-адрес;
   • account — объект, содержащий сведения о банковском счёте пользователя:
     • bank_id — идентификатор банка;
   • return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
     • return — URL для перенаправления пользователя на любом шаге оплаты.
3. Дополнительно рекомендуется указывать имя и фамилию пользователя. Если параметры отсутствуют в запросе, список недостающих параметров отправляется в оповещении на уточнение. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.

   Рекомендуется использовать следующие объекты и параметры:

   • customer — объект, содержащий сведения о пользователе:
     • first_name — имя,
     • last_name — фамилия.
   Также при выборе некоторых банков может потребоваться номер счёта пользователя, в то время как при работе с другими банками этот номер указывается пользователем на стороне провайдера. В случаях, когда необходимо указать номер счёта до перенаправления пользователя к сервису провайдера, в оповещении на уточнение указывается параметр number объекта account; и если в исходном запросе не были указаны параметры first_name и last_name объекта customer, то все эти три параметра указываются в одном оповещении на уточнение. В силу специфики метода, если номер счёта пользователя указывается в исходном запросе, он не учитывается при первичной обработке этого запроса, и может быть указан либо на стороне веб-сервиса после получения оповещения на уточнение, либо на стороне провайдера после перенаправления пользователя.
4. Валютой платежа может быть только GBP.
5. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на оплату с применением метода Open Banking in the UK должен содержать идентификаторы проекта и платежа, подпись, IP-адрес и информацию о пользователе, валюту и сумму платежа, идентификатор банка и URL для перенаправления:

  "general": {
    "project_id": 1111,
    "payment_id":"Test-sale-001",
    "signature": "52D7C03EA096CAB4F27...EC4280509D293D1094AA793BBC"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "1.2.3.4",
    "first_name": "John",
    "last_name": "Doe"
  },
  "account": {
    "bank_id": 3791
  },
  "payment": {
    "amount": 1000,
    "currency": "GBP"
  },
  "return_url": {
    "return": "http://example.com/return"
  }

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

При работе с методом Open Banking in the UK требуется получать дополнительное согласие пользователей на проведение платежей с использованием этого метода. Для проведения платежа с учётом согласия пользователя со стороны веб-сервиса необходимо:

1. Принять от платёжной платформы оповещение о необходимости получения согласия пользователя (и дополнения информации о платеже, если это необходимо).
2. Получить от пользователя это согласие (и дополнительные сведения, если это необходимо).
3. Передать информацию о согласии пользователя (и дополнительные сведения, если это необходимо) в запросе в платёжную платформу.

В оповещении от платёжной платформы в объекте clarification_fields содержится информация о параметрах и объектах, необходимых для проведения платежа. В структуру каждого объекта, включённого в объект clarification_fields, входят:

• Параметры type и description с указанием типа и описания объекта;
• Объект properties с информацией о параметрах, включённых в объект;
• Массив required со списком требуемых параметров;
• Массив errors с информацией о причинах запроса указанных параметров.

Объект properties и массив required указываются в соответствии со спецификацией JSON Schema, а в объектах массива errors приводятся параметры property, message и constraint для указания названий запрошенных параметров, поясняющих сообщений и причин.

Текст, который необходимо отобразить пользователю для получения его согласия на проведение платежа, указывается в параметре clarification_fields.customer.properties.psu_consent_text.default.

В следующем примере приведён фрагмент оповещения о необходимости получения согласия пользователя.

{
"clarification_fields": {
        "customer": {
            "type": "object",
            "description": "Object that contains customer details",
            "properties": {
                "psu_consent": {
                    "type": "string",
                    "description": "Need to request the users consent to make a payment"
                },
                "psu_consent_text": {
                    "type": "string",
                    "description": "The PSU consent text to be displayed on Payment Page",
                    "default": "This consent text with possibly links to some resources here."
                },
                "first_name": {
                    "type": "string",
                    "maxLength": 255,
                    "description": "Customer first name"
                },
                "last_name": {
                    "type": "string",
                    "maxLength": 255,
                    "description": "Customer last name"
                }
            },
            "required": [
                "psu_consent",
                "psu_consent_text",
                "first_name",
                "last_name"
            ],
            "errors": [
                {
                    "property": "customer.psu_consent",
                    "message": "The property psu_consent is required for the clarification request",
                    "constraint": "required"
                },
                {
                    "property": "customer.psu_consent_text",
                    "message": "The property psu_consent_text is required for the clarification request",
                    "constraint": "required"
                },
                {
                    "property": "customer.first_name",
                    "message": "The property first_name is required",
                    "constraint": "required"
                },
                {
                    "property": "customer.last_name",
                    "message": "The property last_name is required",
                    "constraint": "required"
                }
            ]
        },
        "account": {
            "type": "object",
            "description": "Object that contains the details of the customer's bank account for payment performing",
            "properties": {
                "number": {
                    "type": "string",
                    "maxLength": 100,
                    "minLength": 1,
                    "description": "Customer's account number"
                },
                "bank_code": {
                    "type": "string",
                    "maxLength": 100,
                    "minLength": 1,
                    "description": "Customer's bank code"
                }
            },
            "required": [
                "number",
                "bank_code"
            ],
            "errors": [
                {
                    "property": "account.number",
                    "message": "The property number is required",
                    "constraint": "required"
                },
                {
                    "property": "account.bank_code",
                    "message": "The property bank_code is required",
                    "constraint": "required"
                }
            ]
        }
    }
}

Запрос на продолжение платежа с учётом согласия пользователя (и дополнительных сведений, если это необходимо) отправляется методом POST к конечной точке /v2/payment/clarification и должен содержать следующие объекты и параметры:

• general — объект, содержащий основные идентификационные сведения запроса:
  • project_id — идентификатор проекта, к которому относится проводимый платёж.
  • payment_id — идентификатор платежа, к которому относятся отправляемые данные.
  • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным).
• additional_data — объект с информацией о согласии пользователя на проведение платежа (и дополнительными сведениями, если они необходимы):
  • customer — объект, содержащий сведения о пользователе:
    • psu_consent — информация о получении согласия пользователя на проведение оплаты. Если пользователь дал согласие на проведение платежа, необходимо передать значение 1; если указать иное значение, согласие на проведение платежа запрашивается повторно.
    • psu_consent_text — текст запроса согласия пользователя на проведение оплаты, который был отображён пользователю. В значении этого параметра должен передаваться именно тот текст, который был получен в оповещении о необходимости получения согласия пользователя. Если текст, указанный в запросе, отличается от текста, полученного в оповещении, согласие на проведение платежа запрашивается повторно.

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

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

{
    "general": {
        "project_id": 10571,
        "payment_id": "1234567890",
        "signature": "=== signature ==="
    },
    "additional_data": {
        "customer": {
            "psu_consent": "1",
            "psu_consent_text": "=== The PSU consent text to be displayed on payment page ===",
            "first_name": "Firstname",
            "last_name": "Lastname"
        "account": {
            "number": "AB123456789"
        }
    }
}

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

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

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

  "redirect_data": {
    "method": "GET",
    "url": "http://redirect.bank.exmaple.com"
  }

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

Для оповещений о результатах оплат с применением метода Open Banking in the UK используется типовой формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 239 была проведена оплата в размере 10,00 GBP.

{
   "project_id":239,
   "payment":{
      "id":"ID_461239",
      "type":"purchase",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "method":"UK banks",
      "sum":{
         "amount":1000,
         "currency":"GBP"
      },
      "description":"ID_461239"
   },
   "customer":{
      "id":"1"
   },
   "operation":{
      "id":59043000050811,
      "type":"sale",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "created_date":"2020-06-15T14:51:35+0000",
      "request_id":"929c6911448765aedaf4df...79aa8d4adb6b78dc5-00059044",
      "sum_initial":{
         "amount":1000,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":1000,
         "currency":"GBP"
      },
      "code":"0",
      "message":"Success",
      "provider":{
         "id":2901,
         "payment_id":"385dc36c-7fac-4bf5-a0e6-6a16ebcc1962",
         "auth_code":"",
         "endpoint_id":"Halifax",
         "date":"2020-06-15T14:51:36+0000"
      }
   },
   "signature":"+KDWbziHMNDBSd2Y04Cc...xRb55AnjtvrZc4XgG6iXkJyLHPa3ZbYw=="
}

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

{
   "customer":{
      "id":"1"
   },
   "project_id":10801,
   "payment":{
      "id":"ID_542650",
      "type":"purchase",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "method":"UK banks",
      "sum":{
         "amount":100,
         "currency":"GBP"
      },
      "description":"ID_542650"
   },
   "operation":{
      "id":58778000050861,
      "type":"sale",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "created_date":"2020-06-15T11:36:39+0000",
      "request_id":"e6cb17dd0699001b813a0...6753e4dca478c7eb6-00058779",
      "sum_initial":{
         "amount":100,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":100,
         "currency":"GBP"
      },
      "code":"20000",
      "message":"General decline",
      "provider":{
         "id":2901,
         "payment_id":"BARCLAYS-P-10000000420474",
         "auth_code":"",
         "endpoint_id":"Barclays",
         "date":"2020-06-15T11:36:41+0000"
      }
   },
   "signature":"kC6wuur3Q2Dswd7A6R+C...1EaupyvFHs6q/aZ7lW17cUuFhXjHoVWbrTJqQ=="
}

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

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

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

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

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

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

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

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