Indonesian Virtual Accounts

General information

Interaction diagram

Payment processing by using the Indonesian Virtual Accounts payment method requires merchant's web service, one of ecommpay interfaces, and the payment platform of ecommpay, as well the provider service.

Operations support

* 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 Indonesian Virtual Accounts method, to perform a purchase operation, you need to redirect a customer to the provider service.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Supported banks

Payments through the Indonesian Virtual Accounts method are carried out through banks that are supported by this method. Banks have their own identifiers, which are used to initiate 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; 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/indonesia-va/sale/list.

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.

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

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.

General information

In the Indonesian Virtual Accounts 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 either allow your customer to select the Indonesian Virtual Accounts methods from the list of other payment methods on Payment Page or have Payment Page opened with the Indonesian Virtual Accounts method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

Figure: Purchase by using Payment Page

The sections that follow provide details the request format and the Payment Page parameters to use in the Indonesian Virtual Accounts 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 Indonesian Virtual Accounts 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 minor currency units. If the currency IDR is specified in the purchase request it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ecommpay side and rounded up to an integer (for example, if the converted amount is 200,000.05 IDR, such an amount is rounded up to 200,001.00 IDR)
   • customer_id—the unique ID of the customer within your project

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

   By default the supported banks are grouped in one Online Indonesian VA Banks button on Payment Page, so the selection of a bank is carried out in two steps. First, the Indonesian Virtual Accounts method is chosen among others, and then the bank is selected on the next page with the list of banks.

   There are several options for displaying the page with the selecting of payment method on Payment Page:

   • To display grouped in one Online Indonesian VA Banks button on Payment Page in the list of payment methods.
   • To display each bank of the Indonesian Virtual Accounts group with a separate buttons, pass split_banks=true in the request for opening in the payment_methods_options string.

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

   • To preselect Indonesian Virtual Accounts as the payment method on Payment Page for customers, pass the code indonesia-va in the force_payment_method parameter in the request for opening. The list of the banks from Indonesian Virtual Accounts group is displayed to a customer on Payment Page bypassing the page with the payment method selection.
   • To display a button of a specific bank (one or several) from Indonesian Virtual Accounts 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": "{\"indonesia_va\": {\"split_banks\": true, \"banks_id\": [2831, 2931]}}"

     Here is the example of a request for opening Payment Page with preselecting the Mandiri bank.

     Figure: Example of the request for with preselected payment method and bank

     EPayWidget.run(
         { payment_id: 'X03936', 
           payment_amount: 20000000, 
           payment_currency: 'IDR', 
           project_id: 120,
           customer_id: '1',
           force_payment_method: 'indonesia-va',
           payment_methods_options: '{\"indonesia_va\": {\"banks_id\": [2931]}}',
           signature: "kUi2x9dKHAVNU0FY...vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
         }
     )

3. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Indonesian Virtual Accounts 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 Indonesian Virtual Accounts method must include project, customer and payment IDs, the currency and the amount of a payment, as well as signature, as shown in the following example:

    { payment_id: 'X03936', 
      payment_amount: 20000000, 
      payment_currency: 'IDR', 
      project_id: 123,
      customer_id: 'customer1',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }

Callback format

The standard format for callbacks is used to deliver purchase results from Indonesian Virtual Accounts. For more information, see Callbacks.

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 Indonesian Virtual Accounts method, 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. Redirect the customer to the page with a payment instructions.
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 by using Gate

The sections that follow discuss in more details the request format and the Gate parameters to use in the Indonesian Virtual Accounts 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

There are several things you must consider when using purchase requests in the Indonesian Virtual Accounts method:

1. You perform purchase by sending the /v2/payment/banks/indonesia-va/sale request by using POST (HTTP) method, which belongs to the following 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—the 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 minor currency units. If the currency IDR is specified in the purchase request it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ecommpay side and rounded up to an integer (for example, if the converted amount is 200,000.05 IDR, such an amount is rounded up to 200,001.00 IDR)
     • currency—purchase currency in ISO-4217 alpha-3 format
   • 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 Indonesian Virtual Accounts 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": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 35000000,
      "currency": "IDR"
      },
    "customer": {
      "id": "12345",
      "ip_address": "1.1.1.1"
    },
    "account":{
      "bank_id": 2961
    }
 }

Formats of the customer redirection data

• Get a callback with the redirect_data object from the payment platform.
• Generate POST request in the format x-www-form-urlencoded by using parameter values contained in the body object.
• Open the redirect URL by using POST (HTTP) method.

The following example of callback code contains the request method, required parameters, and URL.

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

Callback format

In the Indonesian Virtual Accounts method, the callbacks that deliver purchase results use the standard format described in 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

As with other payment methods ecommpay offers, when using the Indonesian Virtual Accounts 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.