Nganluong Wallet

Обзор

Nganluong Wallet — вьетнамская платёжная система, позволяющая проводить оплаты и выплаты с помощью электронных кошельков. Оплаты осуществляются через Payment Page и Gate, выплаты — через Gate.

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

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

Схема работы

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

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

	Интерфейсы				Суммы, VND
	Payment Page	CMS Plug-ins	Gate	Dashboard (Old Dashboard)	минимум	максимум
Оплаты	+	–	+	–	–	–
Выплаты	–	–	+	–	–	–

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

Проведение оплат с использованием метода Nganluong Wallet выполняется с перенаправлением пользователя в сервис Nganluong Wallet для использования электронного кошелька, проведение выплат — с уведомлением пользователей через веб-сервис мерчанта.

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

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

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

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

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

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

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

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

Пользователь на стороне веб-сервиса инициирует оплату.
От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
Запрос на проведение оплаты поступает в платёжную платформу.
Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
Пользователю отображается сгенерированная платёжная форма.
Пользователь выбирает для оплаты электронный кошелёк Nganluong Wallet.
На Payment Page пользователю отображается страница для ввода адреса электронной почты и телефона.
Пользователь вводит адрес электронной почты и телефон.
Запрос на проведение оплаты через Nganluong Wallet поступает в платёжную платформу.
Выполняются дальнейшая обработка запроса и его отправка в сервис Nganluong Wallet.
На стороне Nganluong Wallet выполняется обработка запроса на оплату.
От сервиса Nganluong Wallet к платёжной платформе передаются данные для перенаправления пользователя в сервис Nganluong Wallet.
Данные для перенаправления пользователя передаются к Payment Page.
Пользователь перенаправляется в сервис Nganluong Wallet.
Пользователь выполняет необходимые действия для оплаты.
На стороне сервиса Nganluong Wallet выполняется обработка платежа.
Результат оплаты отображается пользователю в сервис Nganluong Wallet.
Пользователь перенаправляется к Payment Page.
От сервиса Nganluong Wallet к платёжной платформе направляется результат оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От платёжной платформы к Payment Page направляется результат проведения оплаты.
Результат оплаты отображается пользователю на Payment Page.

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

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

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

Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
Валютой платежа может быть только VND.
Дополнительно должны использоваться параметры customer_email, customer_phone — адрес электронной почты и телефон пользователя в рамках проекта.
Payment Page можно открывать на вьетнамском языке. Для этого необходимо передавать код языка vi в параметре language_code (подробнее — в разделе Поддержка языков интерфейса).
Для предварительного выбора метода Nganluong Wallet с использованием электронного кошелька необходимо указывать код платёжного метода в параметре force_payment_method — nganluong-wallet.
Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех указанных параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

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

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 2000, 
      payment_currency: 'VND', 
      project_id: 0,     
      customer_id: 'customer1',
      customer_email: 'johna@gmail.com',
      customer_phone: 4438336996
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

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

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

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

{
        "project_id": 603,
        "payment": {
            "id": "EP3f43-5d18",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-22T13:36:17+0000",
            "method": "Nganluong wallet",
            "sum": {
                "amount": 2000,
                "currency": "VND"
            },
            "description": ""
        },
        "operation": {
            "id": 2000000471,
            "type": "sale",
            "status": "success",
            "date": "2019-02-22T13:36:17+0000",
            "created_date": "2019-02-22T13:35:13+0000",
            "request_id": "db567db9bf0fdbecba5b7",
            "sum_initial": {
                "amount": 2000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "VND"
            },
            "provider": {
                "id": 1331,
                "payment_id": "19647319",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "iJtnnWh4EyZWnWt0uzv+A3hb//4oz43juZrsYyK4tI6zl01MxRhz0eL7wqYts8ugrA=="
    }

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

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

{
        "project_id": 603,
        "payment": {
            "id": "EPd87a-9ea7",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-22T13:42:26+0000",
            "method": "Nganluong wallet",
            "sum": {
                "amount": 2000,
                "currency": "VND"
            },
            "description": ""
        },
        "operation": {
            "id": 1000000477,
            "type": "sale",
            "status": "decline",
            "date": "2019-02-22T13:42:26+0000",
            "created_date": "2019-02-22T13:42:22+0000",
            "request_id": "251469bcb435b24e9a55dd1b",
            "sum_initial": {
                "amount": 2000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "VND"
            },
            "provider": {
                "id": 1332,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20102",
            "message": "Incorrect account data entered"
        },
        "signature": "9TDUuc8PLSzgwD2jE5MaXIgzhTRYMwYq3PTqN0Gjc+7I59NZCkC5pZ6XA2rQ=="
    }

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

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

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

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

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

Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
Осуществить перенаправление пользователя в сервис Nganluong Wallet.
Принять оповещение о результате оплаты.

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

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

Пользователь на стороне веб-сервиса инициирует оплату через Nganluong Wallet.
От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
Запрос на проведение оплаты поступает в платёжную платформу.
Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Nganluong Wallet.
На стороне Nganluong Wallet выполняется обработка запроса на оплату.
От сервиса Nganluong Wallet к платёжной платформе передаются данные для перенаправления пользователя на сайт сервиса Nganluong Wallet.
От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя на сайт Nganluong Wallet в объекте redirect_data.
Пользователь перенаправляется в сервис Nganluong Wallet.
Пользователь выполняет необходимые действия для оплаты.
На стороне сервиса Nganluong Wallet выполняется обработка платежа.
Пользователю отображается результат оплаты.
Пользователь перенаправляется к веб-сервису.
От сервиса Nganluong Wallet к платёжной платформе направляется уведомление о результате оплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
От веб-сервиса пользователю направляется результат оплаты.

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

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

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

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

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

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

{
    "general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ejrtyUG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 2000,
      "currency": "VND"
      },
    "customer": {
      "ip_address": "248.121.176",
      "email": "1@1.ru",
      "id": "customer123"
    },
    "return_url":{
      "decline" : "http://return.url",
      "success" : "http://return.url"
    }
}

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

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

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

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://www.vn/checkout/version31/index/token_code/24963023"
  }

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

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

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

 {
        "project_id": 603,
        "payment": {
            "id": "TEST_154385980520099",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "method": "Nganluong wallet",
            "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": "Nganluong wallet",
            "sum": {
                "amount": 0,
                "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": 0,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 0,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "010UDR0CCTJEPAN6KFWU14VDN",
                "date": "2019-01-24T09:42:58+0000",
                "auth_code": ""
            },
            "code": "2000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5Qubo0+7RCZWuxc0feItZRcABrPdFA4EKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

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

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

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

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

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

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

Пользователь на стороне веб-сервиса инициирует выплату через метод Nganluong Wallet.
От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
Запрос на проведение выплаты поступает в платёжную платформу.
Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Nganluong Wallet.
На стороне Nganluong Wallet выполняется обработка платежа.
От сервиса Nganluong Wallet к платёжной платформе направляется уведомление о результате выплаты.
От платёжной платформы к веб-сервису направляется оповещение о результате выплаты.
От веб-сервиса пользователю направляется результат выплаты.

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

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

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

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

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

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

{
  "general": {
    "project_id": 603,
    "payment_id": "10000007",
    "signature": "PJkV8ej\/UG0Di8hTncV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
  },
 "account":{
    "number": "john@gmail.com",
 },
 "customer": {
    "id":"2990", 
    "ip_address": "248.121.176.220"
  },
  "payment": {
    "amount": 100000,
    "currency": "VND"
  }
}

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 603 для пользователя 111232323 была успешно проведена выплата в размере 100 000 VND на счёт 123@gamail.com.

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

{
        "project_id": 603,
        "payment": {
            "id": "100000010",
            "type": "payout",
            "status": "success",
            "date": "2019-02-22T13:50:52+0000",
            "method": "Nganluong wallet",
            "sum": {
                "amount": 100000,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "123@gamail.com"
        },
        "customer": {
            "id": "111232323"
        },
        "operation": {
            "id": 2000000472,
            "type": "payout",
            "status": "success",
            "date": "2019-02-22T13:50:52+0000",
            "created_date": "2019-02-22T13:50:48+0000",
            "request_id": "c0c14111edf06ba2",
            "sum_initial": {
                "amount": 100000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "VND"
            },
            "provider": {
                "id": 1331,
                "payment_id": "843",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qeaYBc4TzLFqi9+KOzNw/6V37PNwQXvz50SJDdevayqTjWGDoDatdK4CHaPpw=="
    }

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

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

{
        "project_id": 603,
        "payment": {
            "id": "10000034",
            "type": "payout",
            "status": "decline",
            "date": "2019-02-22T14:00:17+0000",
            "method": "Nganluong wallet",
            "sum": {
                "amount": 0,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "123@gamail.com"
        },
        "customer": {
            "id": "111232323"
        },
        "operation": {
            "id": 2000000474,
            "type": "payout",
            "status": "decline",
            "date": "2019-02-22T14:00:17+0000",
            "created_date": "2019-02-22T14:00:14+0000",
            "request_id": "a43380dbe08d069b0dd61c895db3257",
            "sum_initial": {
                "amount": 0,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 0,
                "currency": "VND"
            },
            "provider": {
                "id": 1330,
                "payment_id": "NganluongID_770",
                "auth_code": ""
            },
            "code": "2000",
            "message": "General decline"
        },
        "signature": "rdewQxGU7ur5cfWWZc76glYgWnb0h6XfZgfMwWJKJMLoC5Pfpcn9TrQC4IamAw=="
    }

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

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

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

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

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

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

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

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