Indonesian Virtual Accounts

Overview

Indonesian Virtual Accounts is the most popular Indonesian alternative payment method that requires the customer to transfer funds to virtual bank account via a banking mobile application, internet banking or physically via ATM. A Virtual Account (VA), 16 digit payment code, is an account created and assigned to each of your paying clients automatically in response to the payment request so that your business would be able to differentiate each payment from the payment source. ecommpay creates a virtual bank account on an interbank network that is unique to the payment. The payments made to the different Virtual Accounts will be automatically aggregated into the merchant's master account.

The customer uses provided information to do a bank transfer into the virtual account before the account expires. A client can perform the bank transfer in the following ways:

  • Physically going to the ATM
  • Mobile banking through bank applications
  • Internet banking

Most (80 %) of transactions in Indonesia occur via bank transfer. ecommpay offers payment processing with major banks in Indonesia—Mandiri, Permata, Danamon, CIMB.

Purchases can be processed by using Payment Page and Gate.

General information

Payment method type bank payments
Payment instruments
  • cash
  • bank accounts
  • payments cards
Countries and regions ID
Payment currencies IDR
Currency conversion on the ecommpay side
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes it is possible to specify additional parameters to preselect the payment method and bank on Payment Page
Onboarding and access fee refer to your ecommpay key account manager

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

  Interfaces Amounts, IDR Times **
Payment Page CMS Plug-ins Gate Dashboard Minimum Maximum basic threshold
Purchases + + * * 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 Indonesian Virtual Accounts method, to perform a purchase operation, you need to redirect a customer to the provider service.

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.

Figure: Example of requesting a list of banks

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "IDR"
  }
}
Table 1. List of banks
Bank ID
Bank Sahabat Sampoerna VA 4391
Permata Virtual Account 433
Mandiri Virtual Account 434
Maybank Virtual Account 2831
BNI Virtual Account 2931
BRI Virtual Account 499
Sinarmas Virtual Account 562

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



Figure: Purchase sequence by using Payment Page

  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 Indonesian Virtual Accounts group.
  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 side.
  11. The provider 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 provider website, where a 16 digit code and payment instructions are displayed to the customer.
  14. In accordance with the payment instructions the customer enters the code on either the bank website, bank mobile application or the ATM, and confirms the purchase.
  15. The payment is processed on the provider side.
  16. The provider service sends the result notification to the payment platform.
  17. The payment platform sends a callback with the payment result to the web service.
  18. The payment platform sends the result to Payment Page.
  19. 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 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.

The following is the example of a callback with an information about successful 200,000.00 IDR purchase made for account 8856113600001045 in the 200 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 200,
        "payment": {
            "id": "9770802",
            "type": "purchase",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": "test"
        },
        "account": {
            "number": "8856113600001045"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 52084000029401,
            "type": "sale",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "created_date": "2020-02-22T17:30:42+0000",
            "request_id": "59b48b4c2d0a2b6a-00052085",
            "sum_initial": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1164,
                "payment_id": "644206",
                "auth_code": "",
                "date": "2020-02-22T22:44:45+0000"
            }
        },
        "signature": "Hekd6+86S592dGuYCHNLADZ8LaBC5/JSKObUxTvkUuCZL4phAiFQA=="
    }

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

Figure: Example of a declined purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "9770802",
            "type": "purchase",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 1000,
                "currency": "IDR"
            },
            "description": "test"
        },
        "account": {
            "number": "8856113600001046"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 52084000029401,
            "type": "sale",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "created_date": "2020-02-22T17:30:42+0000",
            "request_id": "59b48b4c2d0a2b6a-00052085",
            "sum_initial": {
                "amount": 1000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "IDR"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
        },
        "signature": "Hekd6+86S592dGuYCHNLADZ8LaBC5/JSKObUxTvkUuCZL4phAiFQA=="
    }

Related topics

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

Purchase by using Gate

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



Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through the Indonesian Virtual Accounts method 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 redirecting the customer to the provider 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 to the provider website, where a 16 digit code and payment instructions are displayed to the customer.
  11. In accordance with the payment instructions the customer enters the code on either the bank website, bank mobile application or the ATM, and confirms the purchase.
  12. The payment is processed on the provider side.
  13. The provider service sends the payment result notification to the payment platform.
  14. The ecommpay payment platform sends a callback to the web service.
  15. The customer receives the payment result information from the web service.

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:

Figure: Purchase request 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.

The following is the example of a callback with an information about successful 200,000.00 IDR purchase made for account 8856113600001045 in the 200 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 200,
        "payment": {
            "id": "9770802",
            "type": "purchase",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": "test"
        },
        "account": {
            "number": "8856113600001045"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 52084000029401,
            "type": "sale",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "created_date": "2020-02-22T17:30:42+0000",
            "request_id": "59b48b4c2d0a2b6a-00052085",
            "sum_initial": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1164,
                "payment_id": "644206",
                "auth_code": "",
                "date": "2020-02-22T22:44:45+0000"
            }
        },
        "signature": "Hekd6+86S592dGuYCHNLADZ8LaBC5/JSKObUxTvkUuCZL4phAiFQA=="
    }

The following 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": "9770802",
            "type": "purchase",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 1000,
                "currency": "IDR"
            },
            "description": "test"
        },
        "account": {
            "number": "8856113600001046"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 52084000029401,
            "type": "sale",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "created_date": "2020-02-22T17:30:42+0000",
            "request_id": "59b48b4c2d0a2b6a-00052085",
            "sum_initial": {
                "amount": 1000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "IDR"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
        },
        "signature": "Hekd6+86S592dGuYCHNLADZ8LaBC5/JSKObUxTvkUuCZL4phAiFQA=="
    }

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