Vietnamese Online Banking

General information

To process a purchase through Payment Page by using the Vietnamese Online Banking method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.

Generally, when a customer confirms their intention to pay on the side of the web service, they are redirected to Payment Page where they select the payment method and, in the case of working with the Vietnamese Online Banking method, additionally select one of the available banks. However, in some situations, other options for choosing a payment method and bank may be relevant. For example, upon opening Payment Page, you can immediately redirect the customer to the bank selection page or limit the list of supported banks for a particular payment and display only target bank selection buttons to the customer. The specific option of selecting the payment method and bank is determined depending on the parameters specified in the request for opening Payment Page (more details). The following options are available:

• 1—when the payment form is opened, it sequentially displays separate pages for selecting a method and a bank. Then the customer selects the method and the bank (this option is used by default).
• 2—when the payment form is opened, the buttons for selecting other methods and banks supported by this method are displayed on one page. Then the customer selects one of these banks.
• 3—when the payment form is opened, it displays a page with buttons for selecting all available banks for this method. Then the customer selects one of these banks.
• 4—when the payment form is opened, it displays a page with buttons for selecting only specific banks supported by this method. Then the customer selects one of these banks.
• 5—when the payment form is opened, it displays a page requesting confirmation of redirection to the service of the specific bank. Then the customer confirms the redirection.

Figure: 1—Selecting method and bank

Figure: 2—Selecting bank among other methods

Figure: 3—Selecting bank among all available banks

Figure: 4—Selecting bank among specific banks

Figure: 5—Redirection to the service of the specific bank

Information about the formats of requests and callbacks used for processing payments by using the Vietnamese Online Banking method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Vietnamese Online Banking method:

1. The following parameters required for any payment must be specified:
   • project_id—project identifier obtained from ecommpay during integration
   • payment_id—payment identifier unique within the project
   • payment_currency—payment currency code in the ISO-4217 alpha-3 format
   • payment_amount—payment amount in the smallest currency unit
   • customer_id—customer identifier unique within the project
2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.

3. The following are the bank selection options:

   1. Selecting the method and the bank on Payment Page (1)—the default option, applied if the force_payment_method parameter and the payment_methods_options object are not used.
   2. Selecting a bank among other methods on Payment Page (2)—for this option in the payment_methods_options object specify the online_vietnam_banks object containing the split_banks parameter with the value true:

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

   3. Selecting a bank among all available ones on Payment Page (3)—for this option specify the method code online-vietnam-banks in the force_payment_method parameter.
   4. Selecting a bank among specific ones on Payment Page (4)—for this option specify the following:
      • the online-vietnam-banks code in the force_payment_method parameter
      • the payment_methods_options object with the online_vietnam_banks object that contains the split_banks parameter with the value true and a banks_id object with an array containing the target bank identifiers:

        "payment_methods_options": "{\"online_vietnam_banks\": {\"split_banks\": true, \"banks_id\": [134, 132]}}"

   5. Confirming redirection to the service of the specific bank on Payment Page (5)—for this option specify the following:
      • the online-vietnam-banks code in the force_payment_method parameter
      • the payment_methods_options object with the online_vietnam_banks object that contains the split_banks parameter with the value true and a banks_id object with an array containing the target bank identifier:

        "payment_methods_options": "{\"online_vietnam_banks\": {\"split_banks\": true, \"banks_id\": [134]}}"

4. Additionally, any other parameters available for working with Payment Page can be used (details).
5. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Vietnamese Online Banking method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and signature.

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

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

At the same time, in case of selecting a bank among specific banks (4), the request for opening Payment Page may contain additional data.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000000,
   "payment_currency": "VND",
   "customer_id": "customer1",
   "force_payment_method": "online-vietnam-banks",
   "payment_methods_options": "{\"online_vietnam_banks\": {\"split_banks\": true, \"banks_id\": [134, 132]}}",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

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

Useful links

The following articles can be useful when implementing purchases via Payment Page:

• Interaction concepts—about the interaction with the payment platform by using Payment Page.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

To process a purchase through Gate by using the Vietnamese Online Banking method, the merchant's web service is required to do the following:

1. Send a request with all the required parameters and signature to the ecommpay URL.
2. Receive an intermediate callback from the payment platform and redirect the customer to the bank service.
3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Vietnamese Online Banking method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Vietnamese Online Banking method:

1. To initiate each purchase, send a separate POST request to the /v2/payment/banks/vietnam/sale endpoint, which belongs to the 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.

Useful links

The following articles can be useful when implementing purchases via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

To process a payout through Gate by using the Vietnamese Online Banking method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.

Information about the formats of requests and callbacks used for processing payouts by using the Vietnamese Online Banking method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the Vietnamese Online Banking method:

1. To initiate each payout send a separate POST request to the /v2/payment/banks/vietnam/payout endpoint, which belongs to the group /v2/payment/banks/{payment_method}/payout.
2. Each request must include the following objects and parameters:
   • Object general—general payout information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
   • Object payment—payment information:
     • amount—payout amount in the smallest currency unit
     • currency—payout currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payout
   • Object account—customer account information:
     • number—customer account number
     • customer_name—name of bank account holder
     • bank_id—bank identifier
3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Vietnamese Online Banking method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer and account information, as well as signature.

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

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

Useful links

The following articles can be useful when implementing payouts via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• Payouts—about processing of payouts by using Gate.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

For the Vietnamese Online Banking method, it is possible to test purchases by using Payment Page and Gate, as well as payouts by using Gate. To enable and disable testing, as well getting assistance with setting up a test project, refer to ecommpay technical support.

When testing payments keep in mind that the test project identifier must be indicated in requests, the interfaces of the emulator of Payment Page and Vietnamese Online Banking payment forms can differ from the production environment.

Test payments statuses

The final status of test payments and operations is determined by the amount specified in the request.

Test purchases:

• 40000 or 40400 amount to get the decline status
• any other amount to get the success status

Test payouts:

• 40000 or 40400 amount to get the decline status
• any other amount to get the success status

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. Receive the final callback with information about the payment result.

More information about processing purchases by using the Vietnamese Online Banking method via Payment Page is provided in the Purchases by using Payment Page section.

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. Receive the final callback with information about the payment result.

More information about processing purchases by using the Vietnamese Online Banking method via Gate is provided in the Purchases by using Gate section.

Payouts by using Gate

To process a test payout by using Gate, send a valid test request for a payout to the payment platform and receive a final callback with information about the payout result. More information about processing payouts by using the Vietnamese Online Banking method via Gate is provided in the Payouts by using Gate section.