Banks of Thailand

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

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

Рис.: Схема проведения оплаты с выбором банка на Payment Page

Рис.: Схема проведения оплаты с выбором банка на стороне провайдера

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

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

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

1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
   • project_id — идентификатор проекта, полученный от ECommPay при интеграции,
   • payment_id — идентификатор платежа, уникальный в рамках проекта,
   • payment_amount — сумма платежа в минорных единицах валюты,
   • payment_currency — валюта платежа в формате ISO-4217 alpha-3.
2. Обязательно указываются параметры с данными пользователя:
   • customer_id — идентификатор уникальный в рамках проекта,
   • customer_first_name — имя,
   • customer_last_name — фамилия,
   • customer_email — адрес электронной почты пользователя.
3. По умолчанию Payment Page открывается на английском языке. Для изменения языка Payment Page и платёжной страницы сервиса Banks of Thailand необходимо передавать код языка в параметре language_code. Далее приведен список поддерживаемых языков с их кодами, но точный список языков рекомендуется уточнять у курирующего менеджера ECommPay.
   • en — английский,
   • id — индонезийский,
   • ms — малайский,
   • my — бирманский,
   • th — тайский,
   • vi — вьетнамский,
   • zh — китайский.

4. Можно настраивать отображение страницы Payment Page с выбором метода оплаты.

   По умолчанию банки, поддерживающие проведение оплат методом Banks of Thailand, объединены в группу и отображаются одной кнопкой Banks of Thailand, поэтому выбор банка осуществляется в два этапа.

   Оплата через Payment Page с выбором банка на стороне сервиса провайдера

   При использовании платёжного метода Banks of Thailand с выбором банка на стороне сервиса провайдера сначала выбирается метод Banks of Thailand на Payment Page, а затем выполняется выбор конкретного банка на стороне сервиса провайдера. В данном случае можно настраивать отображение Payment Page с предварительно выбранным платёжным методом Banks of Thailand. Для этого необходимо передать код online-thailand-banks в параметре force_payment_method.

   Оплата через Payment Page с выбором банка на стороне Payment Page

   При использовании платёжного метода Banks of Thailand с выбором банка на стороне Payment Page сначала выбирается метод Banks of Thailand среди прочих, а затем на следующей странице с перечнем банков выбирается конкретный банк. Существует несколько вариантов отображения страницы Payment Page с выбором метода оплаты:

   • Отображение каждого банка группы отдельной кнопкой. Для этого необходимо передавать параметр split_banks со значением true в строке payment_methods_options.

     payment_methods_options: {"online_thailand_banks": {"split_banks": true}}
     

   • Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Banks of Thailand. Для этого необходимо передавать идентификаторы банков в параметре banks_id. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом.

     payment_methods_options: {"online_thailand_banks": {"split_banks": true, "banks_id": [125, 126]}}

   • Отображение только банков группы без других методов. Для этого используется предварительный выбор метода Banks of Thailand. Необходимо передавать код платежного метода online-thailand-banks в параметре force_payment_method. Пользователю открывается страница с выбором банков, минуя страницу с выбором метода оплаты.
   • Отображение сайта конкретного банка. Для этого используется предварительный выбор метода Banks of Thailand. Необходимо передавать код платежного метода online-thailand-banks в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options. Перенаправление пользователя на сайта банка осуществляется без подтверждения готовности оплатить, минуя страницы с выбором метода оплаты и с выбором банков.

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

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

     EPayWidget.run(
         { payment_id: 'X03936', 
           payment_amount: 200000, 
           payment_currency: 'THB', 
           project_id: 0,
           customer_id: '1',
           customer_first_name: 'John',
           customer_last_name: 'Johnson',
           customer_email: 'Johnson@mail.com',
           force_payment_method: 'online-thailand-banks',
           payment_methods_options: {"online_thailand_banks": {"banks_id": [125]}},
           signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
         }
     )

   Совет: Для включения и настройки функциональности свяжитесь со службой технической поддержки support@ecommpay.com.
5. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
6. После определения всех параметров необходимо составить подпись. Подробнее — в разделе Работа с подписью к данным.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. Должен использоваться запрос /v2/payment/banks/thailand/sale , отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ECommPay при интеграции,
     • payment_id — идентификатор платежа, уникальный в рамках проекта,
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • ip_address — используемый IP-адрес,
     • id — идентификатор,
     • first_name — имя,
     • last_name — фамилия,
     • email — адрес электронной почты;
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3;
   • account — объект, содержащий сведения о банковском счёте пользователя:
     • bank_id — идентификатор банка. Данный параметр не является обязательным при использовании способа выбора банка на стороне сервиса провайдера;
   • return_url — объект, содержащий URL для перенаправления пользователя после оплаты:
     • success — URL для перенаправления пользователя после проведенной оплаты,
     • decline — URL для перенаправления пользователя после отклоненной оплаты.
3. По умолчанию платёжная страница сервиса Banks of Thailand открывается на английском языке. Для изменения языка платёжной страницы необходимо передать параметр customer.language со значением кода языка. Далее приведен список поддерживаемых языков с их кодами, но точный список языков рекомендуется уточнять у курирующего менеджера ECommPay.
   • en — английский,
   • id — индонезийский,
   • ms — малайский,
   • my — бирманский,
   • th — тайский,
   • vi — вьетнамский,
   • zh — китайский.
4. В зависимости от провайдера, обрабатывающего платёж, для проведения оплаты могут потребоваться другие обязательные параметры, например, имя, фамилия и адрес электронной почты пользователя. В таком случае список параметров отправляется в оповещении на уточнение параметров. Подробнее см. в разделе Дополнение информации о платеже.
5. Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

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

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

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

"redirect_data": {
            "method": "POST",
            "body": {
                "token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJwYXiIwLjEifQ.xAQWCKO-
                          cZ7yRT_n0MjQ3MjY3NSwiaWgwMDk1LCJqdGkiOha2Rt4Cm5IRvoP1oP
                          N2mNOzVWp7LcHgDXa64ah4DtQsMRzrVFTwkiOha2Rt4Cm5IF0IjoxNTQ"
            },
            "encrypted": [],
            "url": "https://payment.allpay.site/api/transfer/v1/payIn/sendTokenForm"
    }

 "redirect_data": {
                    "body": {
                        "amount": "100.00",
                        "currency": "THB"
                    },
                    "method": "POST",
                    "url": "https://secure.example.asia/"
                }
            }

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

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_154382328570677",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T09:24:18+0000",
            "method": "Thailand banks",
            "sum": {
                "amount": 10000,
                "currency": "THB"
            },
            "description": "TEST_1543823285707"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 9327000002098,
            "type": "sale",
            "status": "success",
            "date": "2018-12-03T09:24:18+0000",
            "created_date": "2018-12-03T09:24:14+0000",
            "request_id": "18fb8bdc3f5",
            "sum_initial": {
                "amount": 10000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "THB"
            },
            "provider": {
                "id": 1152,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "LU36QCTjH9FTX3euQRQjhgfghjLC5Zbz3xbV7XARw9trZ2gAKiA=="
    }
}

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

{
        "project_id": 200,
        "payment": {
            "id": "ECT_TEST_1544769530751556",
            "type": "purchase",
            "status": "decline",
            "date": "2018-12-14T07:16:32+0000",
            "method": "Thailand banks",
            "sum": {
                "amount": 100,
                "currency": "THB"
            },
            "description": "ECT_TEST_1544769530751"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 7175000002255,
            "type": "sale",
            "status": "decline",
            "date": "2018-12-14T07:16:32+0000",
            "created_date": "2018-12-14T07:16:30+0000",
            "request_id": "a6baeae100a15878206fcb7883af26e71013e2de-e5d071f07676316e96ff0b294c3e0a952a8f96b9",
            "sum_initial": {
                "amount": 100,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "THB"
            },
            "provider": {
                "id": 1152,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5SwH8wQubo0+7RCZWuxc0feItZRcABrPdFA4EKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

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

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

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

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

Для выплаты через Gate с использованием метода Banks of Thailand со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате выплаты. Однако, в зависимости от провайдера, обрабатывающего платёж, перед отправкой запроса следует обратиться к курирующему менеджеру ECommPay для подтверждения. Полная схема проведения выплаты представлена далее.

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

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

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

1. Должен использоваться запрос /v2/payment/banks/thailand/payout, отправляемый методом POST. Этот запрос относится к группе запросов для проведения платежей в одном из поддерживаемых банков /v2/payment/banks/{payment_method}/payout.
2. В запросе должны использоваться следующие объекты и параметры (обязательность параметров, отмеченных звездочкой (*), необходимо уточнять у курирующего менеджера ECommPay):
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ECommPay при интеграции,
     • payment_id — идентификатор платежа, уникальный в рамках проекта,
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор,
     • first_name* — имя пользователя,
     • last_name* — фамилия пользователя,
     • email* — адрес электронной почты,
     • ip_address — IP-адрес;
   • account — объект, содержащий сведения о банковском счёте пользователя:
     • number — номер счёта,
     • customer_name* — имя держателя банковского счета,
     • bank_id — идентификатор банка,
     • branch — филиал банка,
     • city — город филиала банка,
     • region_id* — регион;
     Прим.: * Обязательность данных параметров необходимо уточнять у курирующего менеджера ECommPay.
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3.
3. Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

Таким образом, корректный запрос на выплату с применением метода Banks of Thailand должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, идентификатор и IP-адрес пользователя, а также данные о счёте пользователя: идентификатор банка, имя держателя, номер (для зачисления средств) и регион:

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

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

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

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

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

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

Для метода Banks of Thailand доступно тестирование оплат через Payment Page и Gate, а также выплат через Gate.

Тестирование может выполняться в рамках тестового проекта, и для подключения и отключения этой функциональности необходимо обращаться к специалистам технической поддержки ECommPay support@ecommpay.com.

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

Статусы тестовых платежей

При тестировании оплат их итоговые статусы определяются исходя из сумм, указанных в запросах:

• decline — при указании суммы 40000 или 40400,
• success — при указании любой другой суммы.

При тестировании выплат их итоговые статусы определяются исходя из сумм, указанных в запросах:

• decline — при указании суммы 40000 или 40400,
• success — при указании любой другой суммы.

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

Для проведения тестовой оплаты через Payment Page необходимо:

1. Отправить в платёжную платформу корректный тестовый запрос на открытие Payment Page.
2. Если в запросе не был указан метод online-thailand-banks — выбрать метод Banks of Thailand на странице эмулятора.
3. Если для выбора доступно несколько банков, то выбрать банк; если для выбора доступен только один банк, то щёлкнуть кнопку Оплатить.
4. Щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы).
5. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода Banks of Thailand через Payment Page представлена в пункте Оплаты через Payment Page.

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

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

1. Отправить в платёжную платформу корректный тестовый запрос на оплату (с указанием идентификатора банка в параметре bank_id, идентификатор следует уточнять у службы технической поддержки ECommPay).
2. Принять оповещение с данными для перенаправления.
3. Перейти по полученному URL и щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы) — на странице эмулятора.
4. Принять оповещение с информацией о результате оплаты.

Подробная информация о проведении оплат с использованием метода Banks of Thailand через Gate представлена в пункте Оплаты через Gate.

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

Для проведения тестовой выплаты через Gate необходимо отправить в платёжную платформу корректный тестовый запрос и принять оповещение с информацией о результате. Подробная информация о проведении выплат с использованием метода Banks of Thailand через Gate представлена в пункте Выплаты через Gate.

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

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

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

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

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