iDeal

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

Схема работы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
        "project_id": 238,
        "payment": {
            "id": "TEST_15452119890903333",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "method": "ideal",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "ECT_TEST_1545211989090"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 18496000002369,
            "type": "sale",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "created_date": "2018-12-20T13:40:15+0000",
            "request_id": "768e72d3284eb2b269e4f3",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "353827769",
                "date": "2018-12-20T13:40:56+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "ylWj/35wPzQRs+9iqEhtIdzE/TjFNQpdwDHjdWcCYMduHnXwxMxYZy17g=="
    }

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

   {
        "project_id": 1569,
        "payment": {
            "id": "145408-190628095914-cmY0LnByZ=",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "method": "ideal",
            "sum": {
                "amount": 300,
                "currency": "EUR"
            },
            "description": "3 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "145408"
        },
        "operation": {
            "id": 33841000003201,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "created_date": "2019-06-28T09:59:16+0000",
            "request_id": "cef7a32aa22a4e4bc8",
            "sum_initial": {
                "amount": 300,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "474810276",
                "date": "2019-06-28T09:59:45+0000",
                "auth_code": ""
            },
            "code": "20301",
            "message": "Account owner cancelled operation"
        },
        "signature": "LifBDhURNHa0MYX4wFBHkoUr5ts4kocEq9eVkzL1UxRCp1JNbQ9M46TyotjGT5io17TSw=="
    }

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

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

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация о выполнении операций

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

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

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

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

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

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

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

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

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

{
    "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": "123"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://merchantsite.com"
    }
}

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

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

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

  "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://simideal?tx=3538269&rs=4fbedb4d72b3f735fa1e4ffd8e"
                }

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

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

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

{
        "project_id": 238,
        "payment": {
            "id": "TEST_15452119890903333",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "method": "ideal",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "TEST_1545211989090"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 18496000002369,
            "type": "sale",
            "status": "success",
            "date": "2018-12-20T13:40:56+0000",
            "created_date": "2018-12-20T13:40:15+0000",
            "request_id": "768e72d3284eb2b269e4f3",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "353827769",
                "date": "2018-12-20T13:40:56+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "ylWj/35wPzQRs+9iqEhtIdzE/TjFNQpdwDHjdWcCYMduHnXwxMxYZy17g=="
    }

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

   {
        "project_id": 1569,
        "payment": {
            "id": "145408-190628095914-cmY0LnByZ=",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "method": "ideal",
            "sum": {
                "amount": 300,
                "currency": "EUR"
            },
            "description": "3 Tage Premium-Mitgliedschaft"
        },
        "customer": {
            "id": "145408"
        },
        "operation": {
            "id": 33841000003201,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-28T09:59:58+0000",
            "created_date": "2019-06-28T09:59:16+0000",
            "request_id": "cef7a32aa22a4e4bc8",
            "sum_initial": {
                "amount": 300,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "474810276",
                "date": "2019-06-28T09:59:45+0000",
                "auth_code": ""
            },
            "code": "20301",
            "message": "Account owner cancelled operation"
        },
        "signature": "LifBDhURNHa0MYX4wFBHkoUr5ts4kocEq9eVkzL1UxRCp1JNbQ9M46TyotjGT5io17TSw=="
    }

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

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

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация об операциях

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

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

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

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

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

1. Должен использоваться запрос /v2/payment/online-banking/ideal/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. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на возврат с применением метода iDeal должен содержать идентификаторы проекта и платежа, подпись и 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"
}
}

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

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

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

 
{
        "project_id": 238,
        "payment": {
            "id": "TEST_15611060328012",
            "type": "purchase",
            "status": "refunded",
            "date": "2019-06-21T11:15:40+0000",
            "method": "ideal",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": ""
        },
        "provider_extra_fields": {
            "description": "Refund"
        },
        "operation": {
            "id": 36084000003050,
            "type": "refund",
            "status": "success",
            "date": "2019-06-21T11:15:40+0000",
            "created_date": "2019-06-21T11:15:38+0000",
            "request_id": "ec1a34153dc43fe1bae7b6397",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": "105796085",
                "date": "2019-06-21T11:15:39+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "DtwI1Wbg6Wda71k/xGHEzVUZXPcCSwT2tyo1q38vy0dGWGE2qHhfA7naVeEk0wtfqg=="
    }

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

{
        "project_id": 238,
        "payment": {
            "id": "TEST_15611060328012",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-21T08:39:50+0000",
            "method": "ideal",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": ""
        },
        "errors": [
            {
                "code": "100",
                "message": "General decline",
                "description": "Gate. Operation was declined. General Gate error"
            }
        ],
        "operation": {
            "id": 36084000003046,
            "type": "refund",
            "status": "decline",
            "date": "2019-06-21T09:42:44+0000",
            "created_date": "2019-06-21T09:42:44+0000",
            "request_id": "5d0c7bf5304685ab9c9613a8e9a86",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1170,
                "payment_id": ""
            },
            "code": "100",
            "message": "General decline"
        },
        "signature": "AX+FugJdXi3kc0KirM5ckfzH6NXlbeHaIUiIjCpaTk94+4gIvrhj/6n3PBA=="
    }

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

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

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация об операциях

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

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

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

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

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