Banks of Vietnam

Обзор

Banks of Vietnam — метод интернет-банкинга для проведения платежей через банки Вьетнама. Для работы с этим методом доступно проведение оплат через Payment Page и Gate, выплат — через Gate.

Для проведения оплат используется два канала. Номер подключённого канала необходимо уточнять у курирующего менеджера ECommPay. Проведение выплат проходит по общему каналу.

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

Тип платёжного метода Интернет-банкинг
Регионы использования VN
Валюты платежей VND
Конвертация валют
Оплаты +
Выплаты +
Оплаты по сохранённым данным
Полные возвраты Для уточнения возможности проведения возвратов, пожалуйста, свяжитесь с вашим курирующим менеджером ECommPay
Частичные возвраты
Опротестования
Особенности
  • Для работы с этим методом через Payment Page поддерживается каскадное проведение оплат. Информацию о поддержке этой возможности можно получить в разделе Каскадное проведение платежей и у курирующего менеджера ECommPay
  • Метод Banks of Vietnam входит в группу методов интернет-банкинга в Юго-Восточной Азии, для которых можно задавать дополнительные параметры при вызове Payment Page
  • Доступны два способа выбора банка: на стороне Payment Page или на стороне провайдера. Подключаемый способ необходимо уточнять у курирующего менеджера ECommPay
  • Для валюты VND суммы указываются без дробной части
  • В браузере Safari может не поддерживаться перенаправление на сервис банка. Подробности необходимо уточнять у курирующего менеджера ECommPay
Организация и стоимость подключения По согласованию с курирующим менеджером ECommPay
Прим.:

Для работы с методом Banks of Vietnam в настоящее время поддерживаются две технических реализации: новая, описанная в данном разделе, и старая, описанная в разделе Banks of Vietnam (legacy).

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

Схема работы

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



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

Интерфейсы Суммы, VND Время **
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) Минимум Максимум Базовое Предельное
Оплаты + + * * до 5 минут 48 часов
Выплаты + * * до 10 минут 48 часов

* Информацию об ограничениях сумм необходимо уточнять у курирующего менеджера ECommPay.

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

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

Проведение оплат с использованием метода Banks of Vietnam выполняется с перенаправлением пользователей на сайты банков, поддерживающих работу с этим методом, проведение выплат — с уведомлением пользователей средствами веб-сервиса.

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



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



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



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



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



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

Проведение платежей с применением метода Banks of Vietnam осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании оплат и выплат через Gate, а также при вызове Payment Page для отображения страницы с выбором метода оплаты.

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

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

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

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

В зависимости от канала, используемого для проведения оплат, различается список доступных банков.

Табл. 1. Канал 1. Список банков
Банк ID Оплаты Выплаты
Agribank 139 +
An Binh Commercial Joint Stock Bank (ABBANK) 465 +
ANZ bank 464 +
Asia Commercial Bank 150 + +
Bac A Commercial Joint Stock Bank (Bac A Bank) 439 +
Bank for Investment and Development of Vietnam 136 + +
Bao Viet Bank 453 +
Citibank 454 +
Dai A Joint-stock Commercial Bank 466 +
DongA Joint Stock Commercial Bank 130 + +
Eximbank Vietnam 135 + +
Global Petro Commercial Joint Stock Bank (GPBank) 444 +
Global Trust Bank 459 +
HoChiMinh City Development Joint Stock Commercial Bank (HDBank) 448 +
HSBC Vietnam 462 +
Joint Stock Commercial Bank for Foreign Trade of Vietnam 133 + +
Joint Stock Commercial Bank for Foreign Trade of Vietnam 456 +
KB Kookmin Bank 458 +
Kien Long Commercial Joint - Stock Bank 455 +
Military JSC Bank (MB) 447 +
Nam A commercial joint stock bank (NamABank) 452 +
National Citizen Bank 442 +
Ocean Commercial One Member Limited Liability Bank (OceanBank) 450 +
Orient Commercial Bank (PhuongDong Bank) 467 +
Petrolimex Group Commercial Joint Stock Bank (PGBank) 443 +
SAIGON Bank 137 +
Saigon Hanoi Commercial Joint Stock Bank (SHB) 451 +
Sai Gon Joint Stock Commercial Bank (SCB) 460 +
Sai Gon Thuong Tin Commercial Joint Stock Bank (SACOM) 131 + +
SHINHAN bank 461 +
SouthEast Asia Joint Stock Commercial Bank (SeaBank) 468  
Standard Chartered Bank 463 +
Tien Phong Commercial Joint Stock Bank (TienPhongBank) 445 +
VietinBank 134 + +
Vietnam Asia Commercial Joint Stock Bank (VietA Bank) 446 +
Vietnam International Bank 138 +
Vietnam Maritime Commercial Joint Stock Bank (MaritimeBank) 440 +
Vietnam Prosperity Bank (VPBank) 449 +
Vietnam Public Joint-stock Commercial Bank 457 +
Vietnam Technological and Commercial Joint Stock Bank 132 + +
Табл. 2. Канал 2. Список банков
Банк ID Оплаты Выплаты
Agribank 139 +
An Binh Commercial Joint Stock Bank (ABBANK) 465 +
ANZ bank 464 +
Asia Commercial Bank 150 + +
Bac A Commercial Joint Stock Bank (Bac A Bank) 439 +
Bank for Investment and Development of Vietnam 136 + +
Bao Viet Bank 453 +
Citibank 454 +
Dai A Joint-stock Commercial Bank 466 +
DongA Joint Stock Commercial Bank 130 + +
Eximbank Vietnam 135 + +
Global Petro Commercial Joint Stock Bank (GPBank) 444 +
Global Trust Bank 459 +
HoChiMinh City Development Joint Stock Commercial Bank (HDBank) 448 +
HSBC Vietnam 462 +
Joint Stock Commercial Bank for Foreign Trade of Vietnam 133 +
Joint Stock Commercial Bank for Foreign Trade of Vietnam 456 + +
KB Kookmin Bank 458 +
Kien Long Commercial Joint - Stock Bank 455 +
Military JSC Bank (MB) 447 +
Nam A commercial joint stock bank (NamABank) 452 +
National Citizen Bank 442 +
Ocean Commercial One Member Limited Liability Bank (OceanBank) 450 +
Orient Commercial Bank (PhuongDong Bank) 467 +
Petrolimex Group Commercial Joint Stock Bank (PGBank) 443 +
SAIGON Bank 137 +
Saigon Hanoi Commercial Joint Stock Bank (SHB) 451 +
Sai Gon Joint Stock Commercial Bank (SCB) 460 +
Sai Gon Thuong Tin Commercial Joint Stock Bank (SACOM) 131 +
SHINHAN bank 461 +
SouthEast Asia Joint Stock Commercial Bank (SeaBank) 468  
Standard Chartered Bank 463 +
Tien Phong Commercial Joint Stock Bank (TienPhongBank) 445 +
VietinBank 134 + +
Vietnam Asia Commercial Joint Stock Bank (VietA Bank) 446 +
Vietnam International Bank 138 +
Vietnam Maritime Commercial Joint Stock Bank (MaritimeBank) 440 +
Vietnam Prosperity Bank (VPBank) 449 +
Vietnam Public Joint-stock Commercial Bank 457 +
Vietnam Technological and Commercial Joint Stock Bank 132 + +

Регионы проведения выплат

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

Табл. 3. Список регионов
Наименование региона Идентификатор региона
An Giang 137
Bà Rịa - Vũng Tàu 138
Bình Dương 139
Bình Phước 140
Bình Thuận 141
Bình Định 142
Bạc Liêu 143
Bắc Giang 144
Bắc Kạn 145
Bắc Ninh 146
Bến Tre 147
Can Tho 148
Cao Bằng 149
Cà Mau 150
Da Nang 151
Gia Lai 152
Ha Noi 153
Hai Phong 154
Ho Chi Minh 155
Hà Giang 156
Hà Nam 157
Hà Tĩnh 158
Hòa Bình 159
Hưng Yên 160
Hải Dương 161
Hậu Giang 162
Khánh Hòa 163
Kiến Giang 164
Kon Tum 165
Lai Châu 166
Long An 167
Lào Cai 168
Lâm Đồng 169
Lạng Sơn 170
Nam Định 171
Nghệ An 172
Ninh Bình 173
Ninh Thuận 174
Phú Thọ 175
Phú Yên 176
Quảng Bình 177
Quảng Nam 178
Quảng Ngãi 179
Quảng Ninh 180
Quảng Trị 181
Sóc Trăng 182
Sơn La 183
Thanh Hóa 184
Thái Bình 185
Thái Nguyên 186
Thừa Thiên-Huế 187
Tiền Giang 188
Trà Vinh 189
Tuyên Quang 190
Tây Ninh 191
Vĩnh Long 192
Vĩnh Phúc 193
Yên Bái 194
Điện Biên 195
Đắk Lắk 196
Đắk Nông 197
Đồng Nai 198
Đồng Tháp 199

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

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

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

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

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



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

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

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



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

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

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

Канал 1. Формат запросов

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

  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. Валютой платежа может быть только VND.
  4. По умолчанию Payment Page открывается на английском языке. Для изменения языка Payment Page и платёжной страницы сервиса Banks of Vietnam необходимо передавать код языка в параметре language_code. Далее приведен список поддерживаемых языков с их кодами, но точный список языков рекомендуется уточнять у курирующего менеджера ECommPay.
    • en — английский,
    • id — индонезийский,
    • ms — малайский,
    • my — бирманский,
    • th — тайский,
    • vi — вьетнамский,
    • zh — китайский.
  5. Можно настраивать отображение страницы Payment Page с выбором метода оплаты.

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

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

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

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

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

    • Отображение каждого банка группы отдельной кнопкой. Для этого необходимо передавать параметр split_banks со значением true в строке payment_methods_options.
      payment_methods_options: {"online_vietnam_banks": {"split_banks": true}}
      
    • Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Banks of Vietnam. Для этого необходимо передавать идентификаторы банков в параметре banks_id. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом.
      payment_methods_options: {"online_vietnam_banks": {"split_banks": true, "banks_id": [135, 136]}}
    • Отображение только банков группы без других методов. Для этого используется предварительный выбор метода Banks of Vietnam. Необходимо передавать код платежного метода online-vietnam-banks в параметре force_payment_method. Пользователю открывается страница с выбором банков, минуя страницу с выбором метода оплаты.
    • Отображение сайта конкретного банка. Для этого используется предварительный выбор метода Banks of Vietnam. Необходимо передавать код платежного метода online-vietnam-banks в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options. Перенаправление пользователя на сайта банка осуществляется без подтверждения готовности оплатить, минуя страницы с выбором метода оплаты и с выбором банков.

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

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

      EPayWidget.run(
          { payment_id: 'X03936', 
            payment_amount: 200000, 
            payment_currency: 'VND', 
            project_id: 0,
            customer_id: '1',
            customer_first_name: 'John',
            customer_last_name: 'Johnson',
            customer_email: 'Johnson@mail.com',
            force_payment_method: 'online-vietnam-banks',
            payment_methods_options: {"online_vietnam_banks": {"banks_id": [135]}},
            signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
      )
    Совет: Для включения и настройки функциональности свяжитесь со службой технической поддержки support@ecommpay.com.
  6. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  7. После определения всех параметров необходимо составить подпись. Подробнее — в разделе Работа с подписью к данным.

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

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

Канал 2. Формат запросов

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

  1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
    • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
    • payment_id — идентификатор платежа, уникальный в рамках проекта;
    • payment_amount — сумма платежа;
    • payment_currency — валюта платежа в формате ISO-4217 alpha-3.
  2. Валютой платежа может быть только VND.
  3. Можно настраивать отображение страницы Payment Page с выбором метода оплаты.

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

    • Отображение каждого банка группы отдельной кнопкой. Для этого необходимо передавать параметр split_banks со значением true в строке payment_methods_options.
      payment_methods_options: {"online_vietnam_banks": {"split_banks": true}}
      
    • Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Banks of Vietnam. Для этого необходимо передавать идентификаторы банков в параметре banks_id. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом.
      payment_methods_options: {"online_vietnam_banks": {"split_banks": true, "banks_id": [135, 136]}}
    • Отображение только банков группы без других методов. Для этого используется предварительный выбор метода Banks of Vietnam. Необходимо передавать код платежного метода online-vietnam-banks в параметре force_payment_method. Пользователю открывается страница с выбором банков, минуя страницу с выбором метода оплаты.
    • Отображение сайта конкретного банка. Для этого используется предварительный выбор метода Banks of Vietnam. Необходимо передавать код платежного метода online-vietnam-banks в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options. Перенаправление пользователя на сайта банка осуществляется без подтверждения готовности оплатить, минуя страницы с выбором метода оплаты и с выбором банков.

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

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

      EPayWidget.run(
          { payment_id: 'X03936', 
            payment_amount: 200000, 
            payment_currency: 'VND', 
            project_id: 1000,
            force_payment_method: 'online-vietnam-banks',
            payment_methods_options: {"online_vietnam_banks": {"banks_id": [135]}},
            signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
      )
    Совет: Для включения и настройки функциональности свяжитесь со службой технической поддержки support@ecommpay.com.
  4. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
  5. После определения всех параметров необходимо составить подпись. Подробнее — в разделе Работа с подписью к данным.

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 200000, 
      payment_currency: 'VND', 
      project_id: 1000,
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_154385980520099",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 100000,
                "currency": "VND"
            },
            "description": "TEST_1543831735980"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 12919000002116,
            "type": "sale",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "created_date": "2018-12-03T13:06:29+0000",
            "request_id": "41fcbd2791eabee713b7d7e89e53",
            "sum_initial": {
                "amount": 100000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Cug4rIB6OimEkwmMBi1OfYpapSpZrz00eNLNIwE/eugWYrFyBErmi0OVw34WpHt5CzEA=="
    }

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 400000000,
                "currency": "VND"
            },
            "description": "TEST_1548313365790"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 3745000002722,
            "type": "sale",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "created_date": "2019-01-24T09:41:49+0000",
            "request_id": "3a872bd43f92091",
            "sum_initial": {
                "amount": 400000000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 400000000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "010UDR0CCTJEPAN6KFWU14VDN",
                "date": "2019-01-24T09:42:58+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5Qubo0+7RCZWuxc0feItZRcABrPdFA4EKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

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

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

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

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

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

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

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

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



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

  1. Пользователь на стороне веб-сервиса инициирует оплату через один из банков, поддерживающих работу с методом Banks of Vietnam.
  2. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
  3. Запрос на проведение оплаты поступает в платёжную платформу.
  4. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  5. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
  6. В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис банка.
  7. На стороне банка выполняется обработка запроса на оплату.
  8. От сервиса банка к платёжной платформе передаются данные для перенаправления пользователя на сайт банка.
  9. От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя на сайт банка.

  10. Пользователь перенаправляется на сайт банка.
  11. Пользователь выполняет необходимые действия для оплаты на сайте банка.
  12. На стороне сервиса банка выполняется обработка платежа.
  13. Пользователю отображается результат оплаты на сайте банка.
  14. Пользователь перенаправляется к веб-сервису.
  15. От сервиса банка к платёжной платформе направляется уведомление о результате оплаты.
  16. От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
  17. От веб-сервиса пользователю направляется результат оплаты.

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



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

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

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

Канал 1. Формат запросов

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

  1. Должен использоваться запрос /v2/payment/banks/vietnam/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 — идентификатор банка. Данный параметр не является обязательным при использовании способа выбора банка на стороне сервиса провайдера.
  3. По умолчанию платёжная страница сервиса Banks of Vietnam открывается на английском языке. Для изменения языка платёжной страницы необходимо передать параметр customer.language со значением кода языка. Далее приведен список поддерживаемых языков с их кодами, но точный список языков рекомендуется уточнять у курирующего менеджера ECommPay.
    • en — английский,
    • id — индонезийский,
    • ms — малайский,
    • my — бирманский,
    • th — тайский,
    • vi — вьетнамский,
    • zh — китайский.
  4. В зависимости от провайдера, обрабатывающего платёж, для проведения оплаты могут потребоваться другие обязательные параметры, например, имя, фамилия и адрес электронной почты пользователя. В таком случае список параметров отправляется в оповещении на уточнение параметров. Подробнее см. в разделе Дополнение информации о платеже.
  5. Валютой платежа может быть только VND.
  6. Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

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

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

{
    "general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ejrtyUG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 300000,
      "currency": "VND",
      },
    "customer": {
      "id":"2990",
      "ip_address": "248.121.176",
      "first_name": "John",
      "last_name": "Johnson",
      "email": "do@mail.com",
    },
    "account":{
      "bank_id": 135
    }
    }

Канал 2. Формат запросов

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

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

    Список дополнительных параметров для проведения платежа зависит от выбранного банка. Если веб-сервис мерчанта поддерживает уточнение дополнительных параметров (Дополнение информации о платеже), то после отправки запроса, содержащего только обязательные параметры, придёт оповещение со списком дополнительных параметров для выбранного пользователем банка.

    В противном случае все указанные в пунктах 2 и 3 параметры необходимо передавать в запросе на оплату.

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

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

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

 {
    "general": {
        "project_id": 603,
        "payment_id": "test_payment_1",
        "signature": "U5LCm6489ly9cXCKIVBNV0mFr4XiCruECSyQEbT1hSXJ70zuH4s05cFDqLks8ZJMR6iNdlUtm1EdHHdA3D19Qg=="
    },
    "payment": {
        "amount": 3000,
        "currency": "VND"
    },
    "account": {
        "bank_id": 505
    },
    "customer": {
        "email": "test@gmail.com"
        "ip_address": "248.121.176.220"
    }
}

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

{
    "general": {
        "project_id": 603,
        "payment_id": "test_payment_1",
        "signature": "U5LCm6489ly9cXCKIVBNV0mFr4XiCruECSyQEbT1h
               SXJ70zuH4s05cFDqLks8ZJMR6iNdlUtm1EdHHdA3D19Qg=="
    },
    "payment": {
        "amount": 3000,
        "currency": "VND"
    },
    "account": {
        "bank_id": 505,
        "number": "1234535456"
        "customer_name": "Ford Prefect"
    },
    "customer": {
        "email": "test@gmail.com",
        "ip_address": "248.121.176.220"
    }
}

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

Для перенаправления пользователя от веб-сервиса на сайт банка необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре 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"
    }
{
  "return_url": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://www.payment.vn/checkout/version31/index/token_code/24962381-f6e99390"
  }

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

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

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_154385980520099",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 300000,
                "currency": "VND"
            },
            "description": "TEST_1543831735980"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 12919000002116,
            "type": "sale",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "created_date": "2018-12-03T13:06:29+0000",
            "request_id": "41fcbd2791eabee713b7d7e89e53",
            "sum_initial": {
                "amount": 300000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 300000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Cug4rIB6OimEkwmMBi1OfYpapSpZrz00eNLNIwE/eugWYrFyBErmi0OVw34WpHt5CzEA=="
    }

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 400000000,
                "currency": "VND"
            },
            "description": "TEST_1548313365790"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 3745000002722,
            "type": "sale",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "created_date": "2019-01-24T09:41:49+0000",
            "request_id": "3a872bd43f92091",
            "sum_initial": {
                "amount": 400000000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 400000000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "010UDR0CCTJEPAN6KFWU14VDN",
                "date": "2019-01-24T09:42:58+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5Qubo0+7RCZWuxc0feItZRcABr
                                    PdFA4EKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

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

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

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

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

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



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

  1. Пользователь на стороне веб-сервиса инициирует выплату через один из банков, поддерживающих работу с методом Banks of Vietnam.
  2. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
  3. Запрос на проведение выплаты поступает в платёжную платформу.
  4. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  5. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности.
  6. В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис банка.
  7. На стороне банка выполняется обработка платежа.
  8. От сервиса банка к платёжной платформе направляется уведомление о результате выплаты.
  9. От платёжной платформы к веб-сервису направляется оповещение о результате выплаты.
  10. От веб-сервиса пользователю направляется результат выплаты.

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

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

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

  1. Должен использоваться запрос /v2/payment/banks/vietnam/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 — регион;
    • payment — объект, содержащий сведения о платеже:
      • amount — сумма платежа без дробной части,
      • currency — валюта платежа в формате ISO-4217 alpha-3.
    Прим.: * Обязательность данных параметров необходимо уточнять у курирующего менеджера ECommPay.
  3. Валютой платежа может быть только VND.
  4. Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

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

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

{
    "general": {
        "project_id": 2990,
        "payment_id": payment_id,
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 350000,
      "currency": "VND"
      },
    "customer": {
      "id": "2990",
      "ip_address": "248.121.176"
    },
  "account":{
      "bank_id": 137,
      "customer_name": "Putra account",
      "number": "314159265358979",
      "region_id": 2296,
      "branch":"Bank branch",
      "city": "Huanin"  
    }
}

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

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

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TESTPAYOUTVIE7896361",
            "type": "payout",
            "status": "success",
            "date": "2018-12-07T12:04:49+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 100001,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "314159265358979",
            "bank_id":155
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 16462000002143,
            "type": "payout",
            "status": "success",
            "date": "2018-12-07T12:04:49+0000",
            "created_date": "2018-12-07T09:34:44+0000",
            "request_id": "0885e52e37cc83c4c3cbc36110a937e6ca150a62-cb2d7b790c01b5d276ef7128577f8fec89c77f67",
            "sum_initial": {
                "amount": 100001,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 100001,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "GKS44OLP249XUCTAG7Y92PK6P",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qV2FRs/wxoOaywQS0GYQDi+6spZFbiRXxt8zG10zy9TNiJLT0P/+EOrpMkoW80mynkaQfSAUJpfQ=="
    }

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TESTPAYOUTVIE789636",
            "type": "payout",
            "status": "decline",
            "date": "2018-12-07T09:32:11+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 100001,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "314159265358979"
        },
        "customer": {
            "id": "1"
        },
        "errors": [
            {
                "code": "2801",
                "message": "Bank ID not found",
                "description": "Gate. Bank ID was not found in request"
            }
        ],
        "operation": {
            "id": 17881000002157,
            "type": "payout",
            "status": "decline",
            "date": "2018-12-07T09:32:11+0000",
            "created_date": "2018-12-07T09:32:11+0000",
            "request_id": "5f7cbc023e850669659b",
            "sum_initial": {
                "amount": 100001,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 100001,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": ""
            },
            "code": "2801",
            "message": "Bank ID not found"
        },
        "signature": "qUOMgCr9BVctnogrHKed3abyrsRoaPHChviFsKtpqNfg4uvso6rg8c2jkjnZrKg/8TCLpagJcQ=="
    }

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

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

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

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

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

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

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

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