Vietnamese Online Banking

General information

In the Vietnamese Online Banking methods, when processing 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 Online Banking method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

The sections that follow provide details the request format and the Payment Page parameters to use in the Vietnamese Online Banking 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.

Request format

There are several things you must consider when performing a purchase through the Vietnamese Online Banking method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • customer_id—the unique ID of the customer within your project
   • 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 in the smallest currency unit

2. You can customize the selecting payment method page on Payment Page.

   By default, banks that support Vietnamese Online Banking payment method are grouped in one button Online Vietnam Banks on Payment Page, so the selection of a bank is carried out in two steps. First, the Vietnamese Online Banking 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 each bank of the Vietnamese Online Banking group with a separate buttons, pass split_banks=true in the request for opening in the payment_methods_options string.

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

   • To display a button of a specific bank (one or several) from Vietnamese Online Banking group on Payment Page in the list of payment methods, pass the bank identifier in the banks_id parameter. 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": "{\"online_vietnam_banks\": {\"split_banks\": true, \"banks_id\": [135, 136]}}"

   • To preselect Vietnamese Online Banking as the payment method on Payment Page for customers, pass the code online-vietnam-banks in the force_payment_method parameter in the request for opening. The list of the banks from Vietnamese Online Banking 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 Online Banking group, pass the code online-vietnam-banks 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.

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

     EPayWidget.run(
         { payment_id: 'X03936', 
           payment_amount: 10000, 
           payment_currency: 'VND', 
           project_id: 654,
           customer_id: '123',
           force_payment_method: 'online-vietnam-banks',
           payment_methods_options: '{\"online_vietnam_banks\": {\"banks_id\": [135]}}',
           signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
         }
     )

3. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Vietnamese Online Banking method, see Parameters for opening payment form.
4. 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 Online Banking method must include project, customer, and payment IDs, the currency and the amount of a payment, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 100000, 
      payment_currency: 'VND',
      customer_id: '123', 
      project_id: 654,
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

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

Related topics

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

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

General information

In the Vietnamese Online Banking 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 Vietnamese Online Banking form.
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 Online Banking 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.

Request format

1. You perform purchase by sending the /v2/payment/banks/vietnam/sale request by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{payment_method}/sale
2. The following objects and parameters must be specified in the request:
   • Object general—general purchase information:
     • project_id—the project ID obtained from ecommpay
     • payment_id—payment ID unique within the project
     • 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—the unique ID of the customer within your project
     • ip_address—customer IP address
   • Object payment—purchase information:
     • amount—purchase amount in the smallest currency unit
     • currency—purchase currency.
   • Object account—customer account information:
     • bank_id—bank identifier
3. If required, you can also add any other additional parameters Gate supports.

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

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

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 a fragment of a callback containing the redirection data.

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

Callback format

The standard format for callbacks is used to deliver purchase results from Vietnamese Online Banking. 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 Online Banking 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 sections that follow discuss in more details the request format and the Gate parameters to use in the Vietnamese Online Banking payment method and provide the information on the format of callbacks with payout results.

Request format

1. You perform payouts by sending the /v2/payment/banks/vietnam/payout request by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{payment_method}/payout
2. The following objects and parameters must be specified in any request:
   • Object general—general payout information:
     • project_id—the project ID obtained from ecommpay
     • payment_id—payout ID unique within the project
     • 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—the unique ID of the customer within your project
     • ip_address—customer IP address
   • Object account—customer account information:
     • number—customer account number
     • customer_name—name of bank account holder
     • bank_id—bank identifier
   • Object payment—payout information:
     • amount—payout amount in the smallest currency unit
     • currency—payout currency in ISO-4217 alpha-3 format.
3. If required, you can also add any other additional parameters that are supported by Gate .

Thus, a correct payout request in the Vietnamese Online Banking method must include project, payout, customer, and bank IDs, account number (for crediting), customer IP address, currency and amount of the payout, as shown in the following example:

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

Callback format

The Vietnamese Online Banking method uses the standard format for callbacks to deliver payout results. 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

For the Vietnamese Online Banking method the testing of purchases by using Payment Page and Gate as well as payouts by using Gate.

Testing can be performed within a test project, to enable and disable the testing availability, contact ecommpay technical support via support@ecommpay.com.

When performing a test payment, take into account that you must specify the identifier of the test project in the requests, the interfaces of the payment forms emulator of Payment Page and Vietnamese Online Banking differ from the production environment.

Test payments statuses

When testing purchases, the final payment status is determined by the amount specified in the request:

• decline status with 40000 or 40400 amount
• success status with any other amount

When testing payouts, the final payment status is determined by the amount specified in the request:

• decline status with 40000 or 40400 amount
• success status with any other amount

Purchases by using Payment Page

To perform a test purchase by using Payment Page, do the following:

1. Send a correct test request for Payment Page opening to the payment platform.
2. If the online-vietnam-banks method was not specified in the request—select the method on the emulator page.
3. If multiple banks are available for selection, select a bank; if only one bank is available, click the Pay button.
4. Click the Success or Decline button (depending on the amount specified in the request).
5. Accept a callback with information about the payment result.

The full information about purchase process by using Vietnamese Online Banking through Payment Page is provided in the section Purchase by using Payment Page.

Purchases by using Gate

To perform a test purchase by using Gate, do the following:

1. Send a correct test request for purchase to the payment platform (the bank_id parameter must be used in the request, refer to ecommpay technical support for the parameter value).
2. Accept a callback with redirection data.
3. Go to the received URL and click the Success or Decline button (depending on the amount specified in the request).
4. Accept a callback with information about the payment result.

The full information about purchase process by using Vietnamese Online Banking through Gate is provided in the section Purchase by using Gate.

Payouts by using Gate

To perform a test payout by using Gate, send a correct test request to the payment platform and accept a callback with information about the payment result. The full information about payout process by using Vietnamese Online Banking through Gate is provided in the section Payout by using Gate.

As with other payment methods ecommpay offers, when using the Vietnamese Online Banking 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.