Banks of Vietnam

Overview

Banks of Vietnam is a payment method that uses the online banking mechanism for payments through Vietnamese banks. You can perform purchases through this method by using Payment Page and Gate, payouts by using Gate.

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

General information

Payment method type Online banking
Countries and regions VN
Payment currencies VND
Currency conversion
Purchases +
Payouts +
Stored credentials payments
Full refunds For the possibility of making refunds, please refer to your ECommPay key account manager
Partial refunds
Chargebacks
Notes
  • Cascade payment processing is supported for working with this method by using Payment Page. For more information, see Cascade payment processing or contact your ECommPay key account manager
  • Banks of Vietnam is one of south-east Asia bank groups and has some particularities when opening Payment Page
  • The amounts for VND currency are specified in the major currency units (without fractional part)
  • Two ways of selecting bank for payment are supported: on the Payment Page side and on the provider side. For more information refer to the ECommPay key account manager
  • Safari browser may not support the redirection to a bank service. For the more details, contact your ECommPay key account manager
Onboarding and access fee Refer to your ECommPay key account manager
Note:

Two technical implementations are currently supported for working with the Banks of Vietnam method: the new one described in this section and the old one described in the section Banks of Vietnam (legacy).

Details about the difference between these implementations and how to switch from the old implementation to the new one should be clarified with the ECommPay key account manager.

Interaction diagram

Payment processing by using the Banks of Vietnam payment method requires merchant's web service, one of the interfaces and the payment platform of ECommPay, as well as one of the bank services which supports this payment method.



Operations support

  Interfaces Amounts, VND Times **
Payment Page CMS Plug-ins Gate Dashboard Minimum Maximum Basic Threshold
Purchases + + * * up to 5 minutes 48 hours
Payouts + * * up to 10 minutes 48 hours

* For the most recent amount limits, contact your ECommPay Key Account Manager.

** The basic and threshold times are defined as follows:
  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

In the Banks of Vietnam 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 with bank selection on the Payment Page side



Figure: Purchase by using Payment Page with bank selection on the provider side



Figure: Purchase by using Gate procedure diagram with redirection to the bank site



Figure: Purchase by using Gate procedure diagram with bank selection on the provider side



Figure: Payout by using Gate procedure diagram



Supported banks

Payments through the Banks of Vietnam 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/vietnam/sale/list to receive the list of banks supporting purchase performing or /v2/info/banks/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 Banks of Vietnam 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 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 +
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 (SACOM) 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 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 +
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 (SACOM) 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 + +

List of regions in the region_id parameter

The region_id parameter is mandatory in the payout request through Banks of Vietnam. 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 Dương 139
Bình Phước 140
Bình Thuận 141
Bình Định 142
Bạc Liêu 143
Bắc Giang 144
Bắc Kạn 145
Bắc Ninh 146
Bến Tre 147
Can Tho 148
Cao Bằng 149
Cà Mau 150
Da Nang 151
Gia Lai 152
Ha Noi 153
Hai Phong 154
Ho Chi Minh 155
Hà Giang 156
Hà Nam 157
Hà Tĩnh 158
Hòa Bình 159
Hưng Yên 160
Hải Dương 161
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
Nam Định 171
Nghệ An 172
Ninh Bình 173
Ninh Thuận 174
Phú Thọ 175
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ái Nguyên 186
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
Vĩnh Phúc 193
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

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 Banks of Vietnam 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 Banks of Vietnam method selected. For more information about preselecting payment methods, see in Preselecting payment method.

Two ways of bank selection are supported: on the Payment Page side and on the provider side.

Figure: Purchase sequence by using Payment Page with bank selection on the Payment Page side



Figure: Purchase sequence by using Payment Page with bank selection on the Payment Page side

  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 from Banks of Vietnam group and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the bank service.
  10. The purchase request is processed on the bank service side.
  11. The bank service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the bank website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the bank side.
  16. The result is displayed to the customer on the bank website.
  17. The customer is redirected to Payment Page.
  18. The bank service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

Figure: Purchase sequence by using Payment Page with bank selection on the provider side



Figure: Purchase sequence by using Payment Page with bank selection on the provider side

  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 the Banks of Vietnam method and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the provider service.
  10. The purchase request is processed on the provider service side.
  11. The provider service generates the data for redirecting the customer to the bank selection page and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the bank selection page.
  14. The customer selects bank for payment.
  15. The customer is redirected to the bank site.
  16. The bank payment form is displayed to the customer.
  17. The customer completes all the payment steps required.
  18. The payment is processed on the bank side.
  19. The result is displayed to the customer on the bank website.
  20. The bank service sends the result notification to the provider service.
  21. The provider service sends the result notification to the payment platform.
  22. The payment platform sends a callback with the payment result to the web service.
  23. The payment platform sends the result to Payment Page.
  24. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow provide details the request format and the Payment Page parameters to use in the Banks of Vietnam 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 must consider when performing a purchase through the Banks of Vietnam 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—purchase amount in the major currency units (without fractional part)
  2. There are more mandatory parameters for this method:
    • customer_id—the unique ID of the customer within your project
    • first_name—customer first name
    • last_name—customer last name
    • email—customer email address
  3. The currency of payment can only be VND.
  4. By default Payment Page is opened in English language. To change the language of Payment Page and payment page of the Banks of Vietnam service pass language code in the language_code parameter in the request for opening. The list of supported languages for the Banks of Vietnam payment method is recommended to check with the ECommPay key account manager. For the informational purposes the list of supported languages and their codes are provided below.
    • en—English
    • id—Indonesian
    • ms—Malay
    • my—Burmese
    • th—Thai
    • vi—Vietnamese
    • zh—Chinese
  5. You can customise the selecting payment method page on Payment Page.

    By default, banks that support Banks of Vietnam payment method are grouped in one button on Payment Page, so the selection of a bank is carried out in two steps.

    Purchase by using Payment Page with bank selection on the provider side

    When performing purchases by using Payment Page with bank selection on the provider side, first, customer chooses the Banks of Vietnam method on the Payment Page, and then customer is redirected to the bank selection page for final bank selection. In that case it is possible to display Payment Page with preselected payment method. For that, pass the online-vietnam-banks code in the force_payment_method parameter.

    Purchase by using Payment Page with bank selection on the Payment Page side

    When performing purchases by using Payment Page with bank selection on the Payment Page side, first, the Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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.

      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: 10000, 
            payment_currency: 'VND', 
            project_id: 0,
            customer_id: 'user123',
            force_payment_method: 'online-vietnam-banks',
            payment_methods_options: {"online_vietnam_banks": {"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 Banks of Vietnam 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 Banks of Vietnam 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', 
      project_id: 0,
      customer_id: '1',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Channel 2. Request format

There are several things you must consider when performing a purchase through the Banks of Vietnam 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 major currency units (without fractional part)
  2. The currency of payment can only be VND.
  3. You can customize the selecting payment method page on Payment Page.

    By default, banks that support Banks of Vietnam payment method are grouped in one button on Payment Page, so the selection of a bank is carried out in two steps. First, the Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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 Banks of Vietnam 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.

      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: 10000, 
            payment_currency: 'VND', 
            project_id: 0,
            customer_id: '123',
            force_payment_method: 'online-vietnam-banks',
            payment_methods_options: {"online_vietnam_banks": {"banks_id": [135]}},
            signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
      )
  4. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Banks of Vietnam method, see Payment Page invocation parameters.
  5. 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 Banks of Vietnam 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: 0,
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

The standard format for callbacks is used to deliver purchase results from Banks of Vietnam. For more information, see Callbacks.

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

Figure: Example of a succeed purchase callback

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

Here is the example of a callback for a purchase rejected due to maximum amount limit.

Figure: Example of a declined purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 400000000,
                "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": 400000000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 400000000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "010UDR0CCTJEPAN6KFWU14VDN",
                "date": "2019-01-24T09:42:58+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5Qubo0+7RCZWuxc0feItZRcABrPdFA4EKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

Related topics

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

Purchase by using Gate

General information

In the Banks of Vietnam 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 Banks of Vietnam 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.

Figure: Purchase sequence by using Gate with redirection to the bank site



Figure: Purchase sequence by using Gate with redirection to the bank site

  1. A customer initiates a purchase through one of the Banks of Vietnam 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 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.

Figure: Purchase sequence by using Gate with redirection to the bank selection page



Figure: Purchase sequence by using Gate with redirection to the bank selection page

  1. A customer initiates a purchase through one of the Banks of Vietnam 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 provider service.
  7. The request is processed on the provider side.
  8. The provider service sends the data for customer redirection to the bank selection page to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected from website to the bank selection page.
  11. The customer selects bank for payment.
  12. The customer is redirected to the bank site.
  13. The bank payment form is displayed to the customer.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the bank side.
  16. The result is displayed to the customer on the bank website.
  17. The customer is redirected to the merchant's web service.
  18. The bank service sends the payment result notification to the provider service.
  19. The provider service sends the payment result notification to the payment platform.
  20. The ECommPay payment platform sends a callback to the web service.
  21. 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 Banks of Vietnam 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 Banks of Vietnam method:
  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—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—the unique ID of the customer within your project
      • ip_address—customer IP address
      • first_name—first name
      • last_name—last name
      • email—email address
    • Object payment—purchase information:
      • amount—purchase amount in the major currency units (without fractional part)
      • currency—purchase currency in ISO-4217 alpha-3 format.
    • Object account—customer account information:
      • bank_id—bank identifier. That parameter is not mandatory for the purchase sequence with redirection to the bank selection page
  3. By default the payment page of the Banks of Vietnam service is opened in English language. To change it pass language code in the customer.language parameter in the request. The list of supported languages for the Banks of Vietnam payment method is recommended to check with the ECommPay key account manager. For the informational purposes the list of supported languages and their codes are provided below.
    • en—English
    • id—Indonesian
    • ms—Malay
    • my—Burmese
    • th—Thai
    • vi—Vietnamese
    • zh—Chinese
  4. Depending on the payment processing provider, other mandatory parameters, such as customer first and last names and email address, may be required to complete the payment. In this case, the list of parameters is sent in the clarification callback. For more details, see Additional payment information submission.
  5. The currency of a purchase can only be VND.
  6. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Banks of Vietnam method must include project, payment, customer, and bank IDs, customer IP-address, 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": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 300000,
      "currency": "VND"
      },
    "customer": {
      "id":"2990",
      "ip_address": "248.121.176"
    },
    "account":{
      "bank_id": 130
    }
    }

Channel 2. Request format

There are several things you must consider when using purchase requests in the Banks of Vietnam method:
  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—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—the unique ID of the customer within your project
      • email—email address
      • ip_address—customer IP address
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency.
    • Object account—customer account information:
      • bank_id—bank identifier
  3. Depending on the bank, some of these additional parameters may be required:

    • account.number—bank account number
    • account.customer_name—name of the account holder

    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 Banks of Vietnam method must include project, payment, and bank IDs, customer email and IP-address, signature, currency and amount of the purchase, as shown in the following example:

Figure: Purchase request example (with clarification support)

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

Figure: Purchase request example (without clarification support)

{
    "general": {
        "project_id": 603,
        "payment_id": "test_payment_1",
        "signature": "U5LCm6489ly9cXCKIVBNV0mFr4XiCruECSyQEbT1h
               SXJ70zuH4s05cFDqLks8ZJMR6iNdlUtm1EdHHdA3D19Qg=="
    },
    "payment": {
        "amount": 3000,
        "currency": "VND"
    },
    "account": {
        "bank_id": 505,
        "number": "1234535456"
        "customer_name": "Ford Prefect"
    },
    "customer": {
        "id": "123",
        "email": "test@gmail.com",
        "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 are the callback fragments containing the redirection data.


"redirect_data": {
              "method": "POST",
              "body": {
                "token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJwYXiIwLjEifQ.xAQWCKO-
                          cZ7yRT_n0MjQ3MjY3NSwiaWgwMDk1LCJqdGkiOha2Rt4Cm5IRvoP1oP
                          N2mNOzVWp7LcHgDXa64ah4DtQsMRzrVFTwkiOha2Rt4Cm5IF0IjoxNTQ"
            },
             "encrypted": [],
             "url": "https://payment.allpay.site/api/transfer/v1/payIn/sendTokenForm"
    }
{
  "return_url": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://www.payment.vn/checkout/version31/index/token_code/24962381-f6e99390"
  }

Callback format

The standard format for callbacks is used to deliver purchase results from Banks of Vietnam. For more information, see Callbacks.

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

Figure: Example of a succeed purchase callback

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_154385980520099",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 300000,
                "currency": "VND"
            },
            "description": "TEST_1543831735980"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 12919000002116,
            "type": "sale",
            "status": "success",
            "date": "2018-12-03T13:06:32+0000",
            "created_date": "2018-12-03T13:06:29+0000",
            "request_id": "41fcbd2791eabee713b7d7e89e53",
            "sum_initial": {
                "amount": 300000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 300000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Cug4rIB6OimEkwmMBi1OfYpapSpZrz00eNLNIwE/eugWYrFyBErmi0OVw34WpHt5CzEA=="
    }

Here is the example of a callback for a purchase rejected due to the exceeded amount limit.

Figure: Example of a declined purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "TEST_1548313365790",
            "type": "purchase",
            "status": "decline",
            "date": "2019-01-24T09:43:27+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 400000000,
                "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": 400000000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 400000000,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "010UDR0CCTJEPAN6KFWU14VDN",
                "date": "2019-01-24T09:42:58+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "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 Banks of Vietnam 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. However, depending on the provider which processes the payment, you should contact the ECommPay key account manager for confirmation before sending the request. 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 Banks of Vietnam 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 Banks of Vietnam service.
  7. The payout is processed on the bank side.
  8. Banks of Vietnam 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 Banks of Vietnam payment method and provide the information on the format of callbacks with payout results.

Request format

There are several things you must consider when using payout requests in the Banks of Vietnam method:
  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 (consult with the ECommPay key account manager whether the parameters marked with asterisk [*] are required):
    • 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
      • first_name*—customer first name
      • last_name*—customer last name
      • email*—email address
      • 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
      • branch—bank branch identifier
      • city—bank branch city
      • region_id—region identifier
    • Object payment—payout information:
      • amount—payout amount in the major currency units (without fractional part)
      • currency—payout currency in ISO-4217 alpha-3 format.
    Note: * Consult with the ECommPay key account manager about necessity of these parameters in the payout request.
  3. The currency of payout can only be VND.
  4. If required, you can also add any other additional parameters that are supported by Gate .

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

Figure: Payout request example

{
    "general": {
        "project_id": 2990,
        "payment_id": payment_id,
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7aRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 350000,
      "currency": "VND"
      },
    "customer": {
      "id":"2990",
      "ip_address": "248.121.176"
    },
    "account":{
      "bank_id": 130,
      "customer_name": "Putra account",
      "number": "314159265358979",
      "region_id": 236,
      "branch":"Bank branch",
      "city": "Huanin"
    }
}

Callback format

The Banks of Vietnam 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 001 VND payout made for account 314159265358979 of the 1 customer in the 200 project.

Figure: Example of a successful payout callback

{
        "project_id": 200,
        "payment": {
            "id": "TESTPAYOUTVIE7896361",
            "type": "payout",
            "status": "success",
            "date": "2018-12-07T12:04:49+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 100001,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "314159265358979",
            "bank_id":155
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 16462000002143,
            "type": "payout",
            "status": "success",
            "date": "2018-12-07T12:04:49+0000",
            "created_date": "2018-12-07T09:34:44+0000",
            "request_id": "0885e52e37cc83c4c3cbc36110a937e6ca150a62-cb2d7b790c01b5d276ef7128577f8fec89c77f67",
            "sum_initial": {
                "amount": 100001,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 100001,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": "GKS44OLP249XUCTAG7Y92PK6P",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qV2FRs/wxoOaywQS0GYQDi+6spZFbiRXxt8zG10zy9TNiJLT0P/+EOrpMkoW80mynkaQfSAUJpfQ=="
    }

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": 200,
        "payment": {
            "id": "TESTPAYOUTVIE789636",
            "type": "payout",
            "status": "decline",
            "date": "2018-12-07T09:32:11+0000",
            "method": "Vietnam banks",
            "sum": {
                "amount": 100001,
                "currency": "VND"
            },
            "description": ""
        },
        "account": {
            "number": "314159265358979"
        },
        "customer": {
            "id": "1"
        },
        "errors": [
            {
                "code": "2801",
                "message": "Bank ID not found",
                "description": "Gate. Bank ID was not found in request"
            }
        ],
        "operation": {
            "id": 17881000002157,
            "type": "payout",
            "status": "decline",
            "date": "2018-12-07T09:32:11+0000",
            "created_date": "2018-12-07T09:32:11+0000",
            "request_id": "5f7cbc023e850669659b",
            "sum_initial": {
                "amount": 100001,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 100001,
                "currency": "VND"
            },
            "provider": {
                "id": 1154,
                "payment_id": ""
            },
            "code": "2801",
            "message": "Bank ID not found"
        },
        "signature": "qUOMgCr9BVctnogrHKed3abyrsRoaPHChviFsKtpqNfg4uvso6rg8c2jkjnZrKg/8TCLpagJcQ=="
    }

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 Banks of Vietnam 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.