Vietnamese ATM cards (NAPAS)

Overview

Vietnamese ATM cards (NAPAS) is a payment method that allows customers to perform payments via domestic cards branded by NAPAS, a local payment service provider that connects to local participating banks. Usual domestic cards in Vietnam are restricted to salary payment and cash withdrawal functions but with possibility to conduct domestic purchases via NAPAS payment provider. Purchases are performed by using Payment Page and Gate, payouts by using Gate.

Purchases are processed by using two channels. Refer to your key account manager ECommPay to learn to which channel you are connected. Payouts are processed by using one channel.

General information

Payment method type Payments by using virtual ATMs
Countries and regions VN
Payment currencies VND
Currency conversion
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds To request full refund contact the ECommPay technical support
Chargebacks
Notes
  • Vietnamese ATM has some particularities when opening Payment Page.
  • The amounts for VND currency are specified in the major currency units (without fractional part)
Onboarding and access fee Refer to your key account manager ECommPay

Interaction diagram

Payment processing through the Vietnamese ATM payment method requires merchant's web service, one of the interfaces and the payment platform of ECommPay, as well as Vietnamese ATM technical facilities one of the bank services which supports this payment method.



Operations support

Interfaces Amounts, VND
Payment Page CMS Plug-ins Gate Dashboard minimum minimum
Purchases + + 2 000 *

Channel 1: customer card limit

Channel 2: 20 000 000 000

Payouts + 100 000 100 000 000

* For most banks minimum amount of the purchase is 2 000 VND, but there is an exception for the Vietcombank—20 000 VND.

Processing scenarios

In the Vietnamese ATM method, to perform a purchase operation, you need to redirect a customer to the bank service, while a payout performs with the notification of a customer via web service.

Figure: Purchase by using Payment Page procedure diagram



Figure: Purchase by using Gate procedure diagram



Figure: Payout by using Gate procedure diagram



Supported banks

Payments through the Vietnamese ATM method are carried out through banks that support the work with this method. Banks have their own identifiers, which are used to initiate payouts and purchases by using Gate, and to display banks on Payment Page when choosing a payment method.

The table below provides information on these banks for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ECommPay Key Account Manager or POST the /v2/info/banks/{payment_method}/{operationType}/list request using Gate API: /v2/info/banks/atm/vietnam/sale/list to receive the list of banks supporting purchase performing or /v2/info/banks/atm/vietnam/payout/list—payout performing.

The request must contain the project and payment IDs, signature, currency, and payment amount, as shown in the example. It is important to specify real payment data, but if the payment has not yet been generated, you can specify a random value for the payment ID in the request.

Figure: Example of requesting a list of banks

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

Depending on the channel there are different banks that support work with the Vietnamese ATM method.

Table 1. Channel 1. List of banks
Bank ID Purchase Payout
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 (Vietcombank) 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 + +
Nam Viet Bank (NaviBank) 441 +
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 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 + +
Table 2. Channel 2. List of banks
Bank ID Purchase Payout
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 456 +
Joint Stock Commercial Bank for Foreign Trade of Vietnam (Vietcombank) 133 + +
KB Kookmin Bank 458 +
Kien Long Commercial Joint - Stock Bank 455 +
Military JSC Bank (MB) 447 + +
Nam A commercial joint stock bank (NamABank) 452 + +
Nam Viet Bank (NaviBank) 441 +
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 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 + +

Regions supporting payout processing

The region_id parameter is mandatory in the payout request through Vietnamese ATM. Payout processing is supported in the regions provided in the table below.

Table 3. List of regions
Region name Region ID
An Giang 137
Bà Rịa - Vũng Tàu 138
Bình Thuận 141
Bình Định 142
Bến Tre 147
Cao Bằng 149
Gia Lai 152
Hà Giang 156
Hà Tĩnh 158
Hòa Bình 159
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
Nghệ An 172
Ninh Bình 173
Ninh Thuận 174
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ừa Thiên-Huế 187
Tiền Giang 188
Trà Vinh 189
Tuyên Quang 190
Tây Ninh 191
Vĩnh Long 192
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
Bắc Kạn 277
Bắc Giang 278
Bạc Liêu 279
Bắc Ninh 280
Bình Dương 281
Bình Phước 282
Cà Mau 283
Can Tho 284
Da Nang 285
Hà Nam 286
Ha Noi 287
Hải Dương 288
Hai Phong 289
Ho Chi Minh 290
Hưng Yên 291
Nam Định 292
Phú Thọ 293
Thái Nguyên 294
Toàn quốc 295
Vĩnh Phúc 296

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Vietnamese ATM method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Vietnamese ATM method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects one of the banks supporting the Vietnamese ATM method.
  8. The page requesting email address and phone number is displayed to the customer on Payment Page.
  9. The customer enters the email address and phone number on Payment Page.
  10. The payment platform receives the purchase request for payment processing from Payment Page.
  11. The payment platform performs the internal purchase request processing and sends it to the bank service.
  12. The purchase request is processed on the bank service side.
  13. The bank service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  14. The payment platform sends the customer redirection data to Payment Page.
  15. The customer is redirected to the bank website.
  16. The customer completes all the payment steps required.
  17. The payment is processed on the bank side.
  18. The result is displayed to the customer on the bank website.
  19. The customer is redirected to Payment Page.
  20. The bank service sends the result notification to the payment platform.
  21. The payment platform sends a callback with the payment result to the web service.
  22. The payment platform sends the result to Payment Page.
  23. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Vietnamese ATM payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Channel 1. Request format

There are several things you need to consider when using the Vietnamese ATM method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount
    • customer_id—customer ID unique within the project
  2. The currency of payment can only be VND.
  3. Additionally toy must pass the customer_email, customer_phone parameters—the email address and phone number of a customer.
  4. To open Payment Page in the language of the bank group, pass the vi code in the language_code parameter in the request for opening. For more information, see Interface language support.
  5. You can customize the selecting payment method page on Payment Page.

    By default, banks that support Vietnamese ATM payment method are grouped in one button on Payment Page, so the selection of a bank is carried out in two steps. First, the Vietnamese ATM method is chosen among others, and then a particular bank is selected on the next page with the list of the group banks. There are several options for displaying the page with the selecting of payment method on Payment Page:

    • To display a button of a specific bank (one or several) from Vietnamese ATM group on Payment Page in the list of payment methods, pass the bank identifier in the banks_id parameter in the payment_methods_options string. If it is necessary to display several banks from a group, pass the identifiers of these banks separated by a comma with a space.
      payment_methods_options: {"vietnam_atm": {"split_banks": true, "banks_id": [135, 136]}}
    • To preselect Vietnamese ATM as the payment method on Payment Page for customers, pass the code vietnam-atm in the force_payment_method parameter in the request for opening. The list of the banks from Vietnamese ATM group is displayed to a customer on Payment Page bypassing the page with the payment method selection.
    • To immediately redirect a customer to the website of the specific bank from the Vietnamese ATM group, pass the code vietnam-atm in the force_payment_method parameter and the bank identifier banks_id in the payment_methods_options string. The customer is redirected to the bank website without confirming willingness to pay, bypassing the pages with the payment method selection and the choice of banks on Payment Page.

      In some cases, providers may request additional parameters that must be passed in the request for Payment Page opening, so that a customer is redirected directly to the bank website page. For details, refer to your ECommPay Key Account Manager.

      Figure: Example of the request for redirecting customer to the bank website

      EPayWidget.run(
          { payment_id: 'X03936', 
            payment_amount: 1000, 
            payment_currency: 'VND', 
            project_id: 0,
            customer_id: 'customer1',
            customer_email: 'johna@gmail.com',
            customer_phone: 84438336996
            force_payment_method: 'vietnam-atm',
            payment_methods_options: {"vietnam_atm": {"banks_id": [135]}},
            signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
      )
  6. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Vietnamese ATM method, see Payment Page invocation parameters.
  7. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Vietnamese ATM method must include project, and payment IDs, the currency and the amount of a payment, the email address and phone number of a customer, as shown in the following example:

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

For information about all parameters available in the Vietnamese ATM method , see Payment Page invocation parameters.

Channel 2. Request format

There are several things you need to consider when using the Vietnamese ATM method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount
  2. The currency of payment can only be VND.
  3. Depending on the bank, additional parameters may be required. They will be requested from the customer on the Payment Page, for more information see Submission of additional payment information.
  4. To open Payment Page in the language of the bank group, pass the vi code in the language_code parameter in the request for opening. For more information, see Interface language support.
  5. You can customize the selecting payment method page on Payment Page.

    By default, banks that support Vietnamese ATM payment method are grouped in one button on Payment Page, so the selection of a bank is carried out in two steps. First, the Vietnamese ATM method is chosen among others, and then a particular bank is selected on the next page with the list of the group banks. There are several options for displaying the page with the selecting of payment method on Payment Page:

    • To display a button of a specific bank (one or several) from Vietnamese ATM group on Payment Page in the list of payment methods, pass the bank identifier in the banks_id parameter in the payment_methods_options string. If it is necessary to display several banks from a group, pass the identifiers of these banks separated by a comma with a space.
      payment_methods_options: {"vietnam_atm": {"split_banks": true, "banks_id": [135, 136]}}
    • To preselect Vietnamese ATM as the payment method on Payment Page for customers, pass the code vietnam-atm in the force_payment_method parameter in the request for opening. The list of the banks from Vietnamese ATM group is displayed to a customer on Payment Page bypassing the page with the payment method selection.
    • To immediately redirect a customer to the website of the specific bank from the Vietnamese ATM group, pass the code vietnam-atm in the force_payment_method parameter and the bank identifier banks_id in the payment_methods_options string. The customer is redirected to the bank website without confirming willingness to pay, bypassing the pages with the payment method selection and the choice of banks on Payment Page.

      In some cases, providers may request additional parameters that must be passed in the request for Payment Page opening, so that a customer is redirected directly to the bank website page. For details, refer to your ECommPay Key Account Manager.

      Figure: Example of the request for redirecting customer to the bank website

      EPayWidget.run(
          { payment_id: 'X03936', 
            payment_amount: 1000, 
            payment_currency: 'VND', 
            project_id: 0,
            force_payment_method: 'vietnam-atm',
            payment_methods_options: {"vietnam_atm": {"banks_id": [135]}},
            signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9
                       SO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
      )
  6. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Vietnamese ATM method, see Payment Page invocation parameters.
  7. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Vietnamese ATM method must include project, and payment IDs, the currency and the amount of a payment, as shown in the following example:

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

For information about all parameters available in the Vietnamese ATM method, see Payment Page invocation parameters.

Callback format

The Vietnamese ATM method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 2 000 VND purchase made by the customer in the 603 project.

Figure: Example of a successful purchase callback

{
        "project_id": 603,
        "payment": {
            "id": "EP3f43-5d18",
            "type": "purchase",
            "status": "success",
            "date": "2019-02-22T13:36:17+0000",
            "method": "ATM Vietnam banking",
            "sum": {
                "amount": 10000,
                "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": 10000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "VND"
            },
            "provider": {
                "id": 1331,
                "payment_id": "19647319",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "iJtnnWh4EyZWnWt0uzv+A3hb//4oz43juZrsYyK4tI6zl01MxRhz0eL7wqYts8ugrA=="
    }

The following is the example of a callback for a purchase declined due to incorrect account data entered by a customer.

Figure: Example of a declined purchase callback

{
        "project_id": 603,
        "payment": {
            "id": "EPd87a-9ea7",
            "type": "purchase",
            "status": "decline",
            "date": "2019-02-22T13:42:26+0000",
            "method": "ATM Vietnam banking",
            "sum": {
                "amount": 10000,
                "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": 10000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "VND"
            },
            "provider": {
                "id": 1332,
                "payment_id": "",
                "auth_code": ""
            },
           "code": "20102",
            "message": "Incorrect account data entered"
        },
        "signature": "9TDUuc8PLSzgwD2jE5MaXIgzhTRYMwYq3PTqN0Gjc+7I59NZCkC5pZ6XA2rQ=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the Vietnamese ATM methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform redirecting customer to the bank service supporting working with the Vietnamese ATM method.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through one of the Vietnamese ATM group banks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the bank service.
  7. The request is processed on the bank side.
  8. The bank service sends the data for redirecting the customer to the selected bank website to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the selected bank website.
  11. The customer completes all the payment steps required on the bank website.
  12. The payment is processed on the bank side.
  13. The result is displayed to the customer on the bank website.
  14. The customer is redirected to the merchant's web service.
  15. The bank service sends the payment result notification to the payment platform.
  16. The ECommPay payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Vietnamese ATM payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Channel 1. Request format

There are several things you must consider when using purchase requests in the Vietnamese ATM method:
  1. You perform purchase by sending the /v2/payment/atm/vietnam/sale request by using POST (HTTP) method. This is an online banking request group: /v2/payment/atm/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • ip_address—IP address
      • email—email address
      • phone—phone number
      • id—the ID of the customer within the merchant project
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format
    • Object account—customer account information:
      • bank_id—bank identifier
  3. The currency of a purchase can only be VND.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Vietnamese ATM method must include project, payment, customer, and bank IDs, customer data, signature, currency and amount of the purchase, as shown in the following example:

Figure: Purchase request example

{
"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",
      "phone": "64891845653",
      "id": "123"
    },
    "account":{
      "bank_id": 135
    }
}

Channel 2. Request format

There are several things you must consider when using purchase requests in the Vietnamese ATM method:
  1. You perform purchase by sending the /v2/payment/atm/vietnam/sale request by using POST (HTTP) method. This is an online banking request group: /v2/payment/atm/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • email—email address
      • ip_address—IP address
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format
    • Object account—customer account information:
      • bank_id—bank identifier
  3. Depending on the bank, some of these additional parameters may be required:
    • card.pan—permanent account number
    • card.card_holder—cardholder name
    • card.year—year of issue or expiration of the card
    • card.month—month of issue or expiration of the card

    The list of required additional parameters depends on the bank. If web service supports clarification of parameters, then you will receive a message with a list of missing parameters in a callback. For more information see Additional payment information submission.

    If web service does not support clarification of parameters, then you need to pass all those parameters (from the second and third points) in the purchase request.

  4. The currency of a purchase can only be VND.
  5. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Vietnamese ATM method must include project, payment, customer, and bank IDs, customer IP-address and e-mail, signature, currency and amount of the purchase, as shown in the following example:

Figure: Purchase request example (with clarification support)

{
"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"
    },
    "account":{
      "bank_id": 135,
    }
}

Figure: Purchase request example (without clarification support)

{
"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"
    },
    "account":{
      "bank_id": 135,
    },
    "card": {
        "pan": "4321432154325432",
        "card_holder": "FORD PREFECT",
        "year": 2018,
        "month": 11
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the bank site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the bank’s HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

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

Callback format

The standard format for callbacks is used to deliver purchase results from Vietnamese ATM. For more information, see Callbacks.

Here is the example of a callback with an information about successful 2,000 VND purchase made by the 1 customer in the 603 project.

Figure: Example of a succeed purchase callback

 {
        "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": "Cug4rIB6OimEkwmMBi1OfYpapSpZrz00eNLNIwE/eugWYrFyBErmi0OVw34WpHt5CzEA=="
    }

The following is the example of a callback for a purchase rejected due to the bank ID is not found in the request.

Figure: Example of a declined purchase callback

{
        "project_id": 603,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "method": "ATM Vietnam banking",
            "sum": {
                "amount": 2000,
                "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": 2000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 2000,
                "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": "cQbMiD0pON9eJc5ZugNK0iT5Qubo0+7RCZWuxc0feItZRcABrPdFA4EKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Payout by using Gate

General information

To perform a payout through the Vietnamese ATM method, merchant's web service sends a request with all the required parameters and signature to ECommPay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.



Figure: Payout sequence by using Gate

  1. A customer orders a payout through one of the supported banks from Vietnamese ATM group.
  2. Merchant's web service sends the payout request for processing the payout by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary check and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the Vietnamese ATM service.
  7. The payout is processed on the bank side.
  8. Vietnamese ATM sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the payout result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Vietnamese ATM payment method and provide the information on the format of callbacks with payout results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using payout requests in the Vietnamese ATM method:
  1. You perform payouts by sending the /v2/payment/atm/vietnam/payout request by using POST (HTTP) method. This is an online banking request group: /v2/payment/atm/{payment_method}/payout
  2. The following objects and parameters must be specified in any request:
    • Object general—general payout information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—identifier
      • ip_address—customer IP address
    • Object account—customer account information:
      • bank_id—bank identifier
      • region_id—region
    • card—customer bank card information:
      • pan—card PAN
      • year—card expiry year
      • month—card expiry month
      • card_holder—card holder name
    • Object payment—payout information:
      • amount—payout amount
      • currency—purchase currency in the ISO-4217 alpha-3 format
  3. The currency of payout can only be VND.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payout request in the Vietnamese ATM method must include project, payment, customer, and bank IDs, account region, customer IP address and card data, currency and amount of the payout, as shown in the following example:

Figure: Example of a payout request

{
  "general": {
    "project_id": 603,
    "payment_id": "10000004",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6LwY3T\/pOMeSaRfBaNIipTv+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": "248.121.176.220"
  },
  "payment": {
    "amount": 100000,
    "currency": "VND"
  }
}

Callback format

The Vietnamese ATM method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100,000 VND payout made for the customer card 424242******4242 in the 603 project.

Figure: Example of a successful payout callback

{
        "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": "qeaYBc4TzLFqi9+KOzNw/6V37PNwQXvz50SJDdevayqTjWGDoDatdK4CHaPpw=="
    }

The following is the example of a callback for a payout rejected due to the bank ID is not found in the request.

Figure: Example of a declined payout callback

{
        "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": "rdewQxGU7ur5cfWWZc76glYgWnb0h6XfZgfMwWJKJMLoC5Pfpcn9TrQC4IamAw=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Vietnamese ATM method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.