Vietnamese ATM cards (NAPAS)

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

Для проведения оплаты через Payment Page с использованием метода Vietnamese ATM со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. При этом можно использовать различные варианты выбора метода и банка, указывая соответствующие параметры в запросах. Полная схема проведения оплаты выглядит следующим образом.

Как правило, после того как пользователь на стороне веб-сервиса подтверждает готовность перейти к оплате, он перенаправляется к Payment Page, выбирает платёжный метод и, в случае работы с методом Vietnamese ATM, дополнительно выбирает один из доступных банков. Вместе с тем, в некоторых ситуациях могут быть актуальны другие варианты выбора платёжного метода и банка. Например, при открытии Payment Page можно сразу перенаправлять пользователя к выбору банка либо ограничивать список поддерживаемых банков для отдельного платежа и отображать пользователю только кнопки выбора целевых банков. Конкретный вариант выбора платёжного метода и банка определяется через параметры, указанные в запросе на открытие Payment Page (подробнее далее), при этом допустимы следующие варианты:

• 1 — при открытии платёжной формы в ней последовательно отображаются отдельные страницы для выбора метода и банка, и пользователь выбирает сначала метод, а затем банк (этот вариант используется по умолчанию);
• 2 — при открытии платёжной формы в ней отображается страница с кнопками выбора методов и банков для данного метода, и пользователь выбирает один из этих банков;
• 3 — при открытии платёжной формы в ней отображается страница с кнопками выбора всех доступных банков для данного метода, и пользователь выбирает один из этих банков;
• 4 — при открытии платёжной формы в ней отображается страница с кнопками выбора заданных банков для данного метода, и пользователь выбирает один из этих банков;
• 5 — при открытии платёжной формы в ней отображается страница подтверждения перенаправления к сервису заданного банка, и пользователь соглашается с этим перенаправлением.

Рис.: 1 — Выбор метода и банка

Рис.: 2 — Выбор банка среди доступных методов

Рис.: 3 — Выбор среди доступных банков

Рис.: 4 — Выбор среди заданных банков

Рис.: 5 — Перенаправление к сервису заданного банка

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

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

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

1. Должен использоваться базовый минимум параметров, обязательный для любого платежа:
   • project_id — идентификатор проекта, полученный от ecommpay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — код валюты платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа (без выделения дробной части, поскольку при работе с валютой VND дробные единицы не используются);
   • customer_id — идентификатор пользователя в рамках проекта.
2. Должен использоваться базовый минимум параметров: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. Валютой платежа может быть только VND.
4. Дополнительно необходимо указывать адрес электронной почты пользователя и номер телефона пользователя в параметрах customer_email и customer_phone.
5. Payment Page можно открывать на вьетнамском языке. Для этого необходимо передавать код языка vi в параметре language_code (подробнее — в разделе Управление языком платёжной формы).

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

   1. Через выбор в Payment Page метода и банка (1) — как вариант по умолчанию, применяемый, если не указываются параметр force_payment_method и объект payment_methods_options, упоминаемые в подпунктах 2–5.
   2. Через выбор в Payment Page банка среди доступных методов (2) — для этого в объекте payment_methods_options необходимо указывать объект vietnam_atm, содержащий параметр split_banks со значением true:

      "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true}}"

   3. Через выбор в Payment Page банка из числа доступных (3) — для этого в параметре force_payment_method необходимо указывать код предварительного выбора метода vietnam-atm.
   4. Через выбор в Payment Page банка из числа заданных (4) — для этого необходимо указывать:
      • код vietnam-atm в параметре force_payment_method;
      • объект payment_methods_options с объектом vietnam_atm, который должен содержать параметр split_banks со значением true и объект banks_id с массивом, включающим в себя идентификаторы целевых банков:

        "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true, \"banks_id\": [135, 136]}}"

   5. Через подтверждение в Payment Page перенаправления к сервису заданного банка (5) — для этого необходимо указывать:
      • код vietnam-atm в параметре force_payment_method;
      • объект payment_methods_options с объектом vietnam_atm, который должен содержать параметр split_banks со значением true и объект banks_id с массивом, включающим в себя идентификатор целевого банка:

        "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true, \"banks_id\": [135]}}"

7. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
8. После указания всех целевых параметров необходимо составлять подпись (подробнее).

Таким образом, корректный запрос на открытие платёжной формы с применением метода Vietnamese ATM должен содержать идентификатор проекта, базовые сведения о платеже (идентификатор, сумму и код валюты), информацию о пользователе и подпись.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "VND",
   "customer_id": "customer1",
   "customer_email": "johna@examle.com",
   "customer_phone": "84438336996",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "VND",
   "customer_id": "customer1",
   "customer_email": "johna@gmail.com",
   "customer_phone": "84438336996",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Вместе с тем, в случае с выбором из заданных банков (4), запрос на открытие Payment Page может содержать расширенный набор данных.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "force_payment_method": "vietnam-atm",
   "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true, \"banks_id\": [135, 136]}}",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

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

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

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

   1. Через выбор в Payment Page метода и банка (1) — как вариант по умолчанию, применяемый, если не указываются параметр force_payment_method и объект payment_methods_options, упоминаемые в подпунктах 2–5.
   2. Через выбор в Payment Page банка среди доступных методов (2) — для этого в объекте payment_methods_options необходимо указывать объект vietnam_atm, содержащий параметр split_banks со значением true:

      "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true}}"

   3. Через выбор в Payment Page банка из числа доступных (3) — для этого в параметре force_payment_method необходимо указывать код предварительного выбора метода vietnam-atm.
   4. Через выбор в Payment Page банка из числа заданных (4) — для этого необходимо указывать:
      • код vietnam-atm в параметре force_payment_method;
      • объект payment_methods_options с объектом vietnam_atm, который должен содержать параметр split_banks со значением true и объект banks_id с массивом, включающим в себя идентификаторы целевых банков:

        "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true, \"banks_id\": [139, 465]}}"

   5. Через подтверждение в Payment Page перенаправления к сервису заданного банка (5) — для этого необходимо указывать:
      • код vietnam-atm в параметре force_payment_method;
      • объект payment_methods_options с объектом vietnam_atm, который должен содержать параметр split_banks со значением true и объект banks_id с массивом, включающим в себя идентификатор целевого банка:

        "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true, \"banks_id\": [139]}}"

7. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page (подробнее).
8. После указания всех целевых параметров необходимо составлять подпись (подробнее).

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "VND",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "VND",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Вместе с тем, в случае с выбором из заданных банков (4), запрос на открытие Payment Page может содержать расширенный набор данных.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "force_payment_method": "vietnam-atm",
   "payment_methods_options": "{\"vietnam_atm\": {\"split_banks\": true, \"banks_id\": [139, 465]}}",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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

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

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

{
        "project_id": 603,
        "payment": {
            "id": "EP3f43-5d18",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-22T13:36:17+0000",
            "method": "ATM Vietnam banking",
            "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": "iJtnnWh4EyZWnWt0uzv01MxRhz0eL7wqYts8ugrA=="
    }

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

{
        "project_id": 603,
        "payment": {
            "id": "EPd87a-9ea7",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-22T13:42:26+0000",
            "method": "ATM Vietnam banking",
            "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": "9TDUuc8PLSzgwD2jE5M+7I59NZCkC5pZ6XA2rQ=="
    }

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

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

• Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
• Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Разовая оплата в одну стадию — о том, как проводить разовые оплаты через Payment Page.
• Информация о выполнении операций — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.

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

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

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

Полная схема проведения оплаты выглядит следующим образом.

Информация о форматах запросов и оповещений, используемых для проведения оплат методом Vietnamese ATM через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

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

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

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

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

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

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

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

   • pan — номер карты пользователя,
   • card_holder — имя держателя карты,
   • year — год выдачи или истечения срока действия карты,
   • month — месяц выдачи или истечения срока действия карты.

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

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

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

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

{
"general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ejrtyUGaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 2000,
      "currency": "VND"
      },
    "customer": {
      "ip_address": "192.0.2.0",
      "email": "email@example.com",
      "id": "customer1"
    },
    "account":{
      "bank_id": 135
    }
}

{
"general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ejrtyUGaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 2000,
      "currency": "VND"
      },
    "customer": {
      "ip_address": "192.0.2.0",
      "email": "email@example.com",
      "id": "customer1"
    },
    "account":{
      "bank_id": 135
    }
}

{
"general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ejrtyUG0aC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 2000,
      "currency": "VND"
      },
    "customer": {
      "ip_address": "192.0.2.0",
      "email": "email@example.com",
      "id": "customer1"
    },
    "account":{
      "bank_id": 135,
    },
    "card": {
        "pan": "4314220000000056",
        "card_holder": "FORD PREFECT",
        "year": 2018,
        "month": 11
    }
}

{
"general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ejrtyUG0aC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 2000,
      "currency": "VND"
      },
    "customer": {
      "ip_address": "192.0.2.0",
      "email": "email@example.com",
      "id": "customer1"
    },
    "account":{
      "bank_id": 135,
    },
    "card": {
        "pan": "4321432154325432",
        "card_holder": "FORD PREFECT",
        "year": 2018,
        "month": 11
    }
}

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

Для перенаправления пользователей от веб-сервиса мерчанта к сервису Vietnamese ATM при проведении каждого платежа с использованием метода Vietnamese ATM необходимо принять промежуточное оповещение от платёжной платформы и использовать информацию из него, включённую в объект redirect_data. Формат таких оповещений является типовым (подробнее), при этом в состав объекта redirect_data включаются следующие объекты и параметры:

• body — объект с данными для отправки в теле запроса;
• method — параметр с указанием HTTP-метода отправки запроса (GET или POST);
• url — параметр со ссылкой для перенаправления.

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

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

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

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

 {
        "project_id": 603,
        "payment": {
            "id": "TEST_154385980520099",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "method": "ATM Vietnam banking",
            "sum": {
                "amount": 2000,
                "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": 2000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Cug4rIB6OimEkwmE/eugWYrFyBErmi0OVw34WpHt5CzEA=="
    }

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

{
        "project_id": 603,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "method": "ATM Vietnam banking",
            "sum": {
                "amount": 4000,
                "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": 4000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 4000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "010UDR0CCTJEPAN6KFWU14VDN",
                "date": "2019-01-24T09:42:58+0000",
                "auth_code": ""
            },           
           "errors": [
            {
                "code": "2801",
                "message": "Bank ID not found",
                "description": "Gate. Bank ID was not found in request"
             }
           ],
            "code": "2801",
            "message": "Bank ID not found"
        },
        "signature": "cQbMiD0pON9eJc5ZugNQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

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

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

• Организация взаимодействия — о том, как взаимодействовать с платёжной платформой через Gate.
• Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Разовая оплата в одну стадию — о том, как проводить разовые оплаты через Gate.
• Информация об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.

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

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

Информация о форматах запросов и оповещений, используемых для проведения выплат методом Vietnamese ATM через Gate, приведена далее в этом разделе; общая информация о работе с Gate API — в отдельной статье Организация взаимодействия.

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

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

1. Для инициирования каждой выплаты должен использоваться отдельный POST-запрос к конечной точке /v2/payment/atm/vietnam/payout. Эта конечная точка относится к группе /v2/payment/atm/{payment_method}/payout.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ecommpay при интеграции;,
     • payment_id — идентификатор платежа, уникальный в рамках проекта;,
     • signature — подпись запроса, составленная после указания всех целевых параметров (подробнее — в разделе Работа с подписью к данным); (подробнее),
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа (без выделения дробной части, поскольку при работе с валютой VND дробные единицы не используются);,
     • currency — код валюты платежа в формате ISO-4217 alpha-3;,
   • customer — сведения о пользователе:
     • id — идентификатор пользователя, уникальный в рамках проекта;,
     • ip_address — IP-адрес пользователя, актуальный для инициируемой выплаты;,
   • account — сведения о счёте пользователя:
     • bank_id — идентификатор банка;,
     • region_id — регион;,
   • card — сведения о платёжной карте пользователя:
     • pan — PAN (Primary Account Number) карты;,
     • year — год истечения срока действия карты;,
     • month — месяц истечения срока действия карты;,
     • card_holder — имя держателя карты.
3. Валютой платежа может быть только VND.
4. Дополнительно могут использоваться любые другие параметры из числа указанных в спецификации.

Таким образом, корректный запрос на выплату с применением метода Vietnamese ATM должен содержать идентификатор проекта, базовые сведения о платеже (его идентификатор, сумму и код валюты), информацией о пользователе и его платёжной карте, номер счёта и подпись.

{
  "general": {
    "project_id": 603,
    "payment_id": "10000004",
    "signature": "PJkV8ej\/UG0Di8hTnaNIipTv+AWoXW\/9MTO8yJA=="
  },
  "card": {
    "pan": "4242424242424242",
    "month": 12,
    "year": 2021,
    "card_holder": "Card Holder"
  },
 "account":{
      "bank_id": 130,
      "region_id": 137
 },
 "customer": {
    "id":"2990", 
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 100000,
    "currency": "VND"
  }
}

{
  "general": {
    "project_id": 603,
    "payment_id": "10000004",
    "signature": "PJkV8ej\/UG0Di8hTnaNIipTv+AWoXW\/9MTO8yJA=="
  },
  "card": {
    "pan": "4314220000000056",
    "month": 12,
    "year": 2021,
    "card_holder": "Card Holder"
  },
 "account":{
      "bank_id": 130,
      "region_id": 137
 },
 "customer": {
    "id":"2990", 
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 100000,
    "currency": "VND"
  }
}

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

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

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

{
        "project_id": 603,
        "payment": {
            "id": "100000010",
            "type": "payout",
            "status": "success",
            "date": "2019-02-22T13:50:52+0000",
            "method": "ATM Vietnam banking",
            "sum": {
                "amount": 100000,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "424242******4242"
        },
        "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": 100000,
                "currency": "VND"
            },
            "provider": {
                "id": 1331,
                "payment_id": "843",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qeaYBc4TzLFqiQXvz50SJDdevayqTjWGDoDatdK4CHaPpw=="
    }

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

{
        "project_id": 603,
        "payment": {
            "id": "10000034",
            "type": "payout",
            "status": "decline",
            "date": "2019-02-22T14:00:17+0000",
            "method": "ATM Vietnam banking",
            "sum": {
                "amount": 100000,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "424242******4242"
        },
        "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": 100000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "VND"
            },
            "provider": {
                "id": 1330,
                "payment_id": "770",
                "auth_code": ""
            },
           "errors": [
            {
                "code": "2801",
                "message": "Bank ID not found",
                "description": "Gate. Bank ID was not found in request"
             }
           ],
            "code": "2801",
            "message": "Bank ID not found"
        },
        "signature": "rdewQxGU7ur5c0h6XfZgfMwWJKJMLoC5Pfpcn9TrQC4IamAw=="
    }

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

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

• Организация взаимодействия — о том, как взаимодействовать с платёжной платформой через Gate.
• Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
• Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
• Выплаты — о том, как проводить выплаты через Gate.
• Информация об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.