Vietnamese Online Banking

Обзор

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

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

Тип платёжного метода банковские платежи
Платёжные инструменты банковские счета
Регионы использования VN
Валюты платежей VND
Конвертация валют на стороне ecommpay
Оплаты +
Выплаты +
Оплаты по сохранённым данным
Возвраты
Опротестования
Особенности
  • Метод Vietnamese Online Banking входит в группу методов интернет-банкинга в Юго-Восточной Азии, для которых можно задавать дополнительные параметры при вызове Payment Page
  • Для валюты VND суммы указываются без дробной части
  • В браузере Safari может не поддерживаться перенаправление на сервис банка. Подробности необходимо уточнять у курирующего менеджера ecommpay
Организация и стоимость подключения По согласованию с курирующим менеджером ecommpay

Схема работы

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



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

Суммы, VND
минимум максимум
Оплаты 100 000 300 000 000
Выплаты 100 000 300 000 000

Ограничения по времени выполнения операций зависят от банков, поддерживающих оплату этим методом.

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

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

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

Проведение платежей с применением метода Vietnamese Online Banking осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании оплат и выплат через 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. Список банков
Банк ID Оплаты Выплаты
Agribank 139 + +
Asia Commercial Bank 150 + +
Bank for Investment and Development of Vietnam 136 + +
DongA Joint Stock Commercial Bank 130 + +
Eximbank Vietnam 135 + +
Joint Stock Commercial Bank for Foreign Trade of Vietnam 133 + +
Sai Gon Thuong Tin Commercial Joint Stock Bank 131 + +
VietinBank 134 + +
Vietnam Technological and Commercial Joint- stock Bank 132 + +

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "154385980520099",
            "type": "purchase",
            "status": "success",
            "date": "2022-09-07T13:06:32+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 100000,
                "currency": "VND"
            },
            "description": "1543831735980"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 12919000002116,
            "type": "sale",
            "status": "success",
            "date": "2022-09-07T13:06:32+0000",
            "created_date": "2022-09-07T13: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/eugWw34WpHt5CzEA=="
    }

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2022-09-07T09:43:27+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 400000000,
                "currency": "VND"
            },
            "description": "548313365790"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 3745000002722,
            "type": "sale",
            "status": "decline",
            "date": "2022-09-07T09:43:27+0000",
            "created_date": "2022-09-07T09:41:49+0000",
            "request_id": "3a872bd43f92091",
            "sum_initial": {
                "amount": 400000000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 400000000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "DR0CCTJEPAN6KFWU14VDN",
                "date": "2022-09-07T09:42:58+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5Qubo0KQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

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

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

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

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

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

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

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



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

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

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

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

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

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

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

Таким образом, корректный запрос на оплату с применением метода Vietnamese Online Banking должен содержать идентификаторы проекта и платежа, подпись, сумму и код валюты платежа, идентификатор банка, идентификатор пользователя и IP-адрес устройства пользователя.

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

 {
    "general": {
        "project_id": 603,
        "payment_id": "test_payment_1",
        "signature": "U5LCm6489ly9cXCKIVBNV0mFr4XiCZJMR6iNdlUtm1EdHHdA3D19Qg=="
    },
    "payment": {
        "amount": 3000,
        "currency": "VND"
    },
    "account": {
        "bank_id": 505
    },
    "customer": {
        "id":"2990",
        "ip_address": "248.121.176.220"
    }
}

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

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

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

{
    "redirect_data": {
                    "body": {},
                    "method": "POST",
                    "url": "http://example.test//payment"
                },
    }

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

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

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

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

 {
        "project_id": 200,
        "payment": {
            "id": "154385980520099",
            "type": "purchase",
            "status": "success",
            "date": "2022-09-07T13:06:32+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 300000,
                "currency": "VND"
            },
            "description": "1543831735980"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 12919000002116,
            "type": "sale",
            "status": "success",
            "date": "2022-09-07T13:06:32+0000",
            "created_date": "2022-09-07T13: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/eugWw34WpHt5CzEA=="
    }

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

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

{
        "project_id": 200,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2022-09-07T09:43:27+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 400000000,
                "currency": "VND"
            },
            "description": "548313365790"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 3745000002722,
            "type": "sale",
            "status": "decline",
            "date": "2022-09-07T09:43:27+0000",
            "created_date": "2022-09-07T09:41:49+0000",
            "request_id": "3a872bd43f92091",
            "sum_initial": {
                "amount": 400000000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 400000000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "DR0CCTJEPAN6KFWU14VDN",
                "date": "2022-09-07T09:42:58+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5Qubo0KQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

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

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

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

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

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



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

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

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

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

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

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

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

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

{
    "general": {
        "project_id": 2990,
        "payment_id": payment_id,
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQAWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 350000,
      "currency": "VND"
      },
    "customer": {
      "id": "2990",
      "ip_address": "248.121.176"
    },
  "account":{
      "bank_id": 137,
      "customer_name": "Putra account",
      "number": "314159265358979"
    }
}

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

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

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

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

{
        "project_id": 200,
        "payment": {
            "id": "PAYOUTVIE7896361",
            "type": "payout",
            "status": "success",
            "date": "2022-09-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": "2022-09-07T12:04:49+0000",
            "created_date": "2022-09-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": "GKS44OLP7Y92PK6P",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qV2FRs/wxoOaywQS0GYQDi+6spZFbiRXxt8zG10zy9TNiJLT0P/+EOrpMkoW80mynkaQfSAUJpfQ=="
    }

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

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

{
        "project_id": 200,
        "payment": {
            "id": "PAYOUTVIE789636",
            "type": "payout",
            "status": "decline",
            "date": "2022-09-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": "2022-09-07T09:32:11+0000",
            "created_date": "2022-09-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 также могут быть полезны следующие материалы:

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

При использовании интерфейса Dashboard можно проводить одиночные и массовые выплаты методом Vietnamese Online Banking с единичной и пакетной отправкой запросов, называемые соответственно одиночными и массовыми.

  • Для проведения одиночной выплаты необходимо открыть форму выплаты, задать все необходимые параметры (включая метод), отправить запрос и убедиться в проведении выплаты.
  • Для проведения массовой выплаты необходимо подготовить и загрузить файл с информацией обо всех целевых выплатах, отправить пакет запросов и убедиться в проведении выплат.

    При этом должен использоваться файл формата CSV, структура которого соответствует требованиям, представленным в разделе Сведения о массовых платежах, а параметры выплат — требованиям, представленным в разделе Выплаты через Gate этой статьи (за исключением пункта о подписи).

Более подробная информацияИнформация о проведении выплат через Dashboard представлена в отдельном разделе.

Тестирование

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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