Vietnamese ATM cards (NAPAS)

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 methods.

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

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 Parameters for opening payment form.
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 Parameters for opening payment form.

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 Parameters for opening payment form.
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 Parameters for opening payment form.

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.

{
        "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.

{
        "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:

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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.

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

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:

{
"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

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 Submission of additional payment information.

   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:

{
"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,
    }
}

{
"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.

Related topics

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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.

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

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:

{
  "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.

{
        "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.

{
        "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:

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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.