Multibanco

Обзор

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

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

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

Схема работы

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



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

Интерфейсы Суммы, EUR Время*
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) минимум максимум базовое предельное
Оплаты + + 99 999,99 7 дней
* Базовое и предельное время определяются следующим образом:
  • Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
  • Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус decline. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.

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

Проведение оплат с использованием метода Multibanсo выполняется пользователями с помощью полученной инструкции.

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



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



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

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

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

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

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

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

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

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

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

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

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

EPayWidget.run(
    { project_id: 0, 
      payment_id: 'X03936',
      payment_amount: 10000, 
      payment_currency: 'EUR', 
      customer_id: 'customer1',
      customer_first_name: 'John',
      customer_last_name: 'Johnson',
      customer_email: 'John@mail.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "multibanco",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002914,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": "148907",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
    }
}

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

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

{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_15593086938557",
            "type": "purchase",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "method": "multibanco",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "description": "TEST_15593086938557"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 24680000002456,
            "type": "sale",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "created_date": "2019-05-31T13:20:11+0000",
            "request_id": "c4a6cb475cf610bac95feba1",
            "sum_initial": {
                "amount": 100,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 1,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "KDgghuSnXgvc9V9smeF+rDsDhKC2JvPwQKkDNO940esLz/88b/uRrI04ggf2ALg=="
    }
}

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

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

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

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

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

  1. Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
  2. Принять оповещение с данными для совершения банковского перевода и передать их пользователю ввиде инструкции или принять оповещение с данными для перенаправления пользователя в сервис Multibanсo (в зависимости от канала проведения платежа).
  3. Принять оповещение о результате оплаты.

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



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

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

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

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

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

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

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

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

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

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

В зависимсоти от канала, через который проходит платеж, для завершения оплаты необходимо отобразить пользователям инструкцию по оплате или перенаправить в сервис Multibanсo. Для передачи данных пользователям ввиде инструкции необходимо принять оповещение от платёжной платформы, содержащее объект provider_extra_fields с необходимыми данными:
  • service_suppler_id — идентификатор банка, выбранного пользователем для оплаты,
  • payment_reference — номер (идентификатор) платежа для совершения оплаты.
Для перенаправления пользователя от веб-сервиса в сервис Multibanсo необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы методом, указанным в redirect_data.method.

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

Рис.: Фрагмент оповещения с данными для инструкции

{
"provider_extra_fields": {
            "service_suppler_id": "11854",
            "payment_reference": "646511672",
            "merchant_site_url": "https://merchant.com/"
        }
}

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

 "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://example.com/en/payments/pay/0a0ffa98-98da-11eed6528"
                }

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

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

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

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

{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "multibanco",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002914,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": "148907",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
    }
}

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

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

{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_15593086938557",
            "type": "purchase",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "method": "multibanco",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "description": "TEST_15593086938557"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 24680000002456,
            "type": "sale",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "created_date": "2019-05-31T13:20:11+0000",
            "request_id": "c4a6cb475cf610bac95feba1",
            "sum_initial": {
                "amount": 100,
                "currency": "RUB"
            },
            "sum_converted": {
                "amount": 1,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "KDgghuSnXgvc9V9smeF+rDsDhKC2JvPwQKkDNO940esLz/88b/uRrI04ggf2ALg=="
    }
}

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

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

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

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

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

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

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

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