Indonesian Virtual Accounts

Introduction

General information

Interaction diagram

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

Operations support

Various platform interfaces can be used to process payments and perform operations using the Indonesian Virtual Accounts method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links). At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the Indonesian Virtual Accounts the following properties and limitations are applicable.

Processing scenarios

To perform a purchase by using the Indonesian Virtual Accounts method, you need to redirect customer to the provider service.

Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

At the same time, the specifics of working with the method include the necessity of selecting a bank for each payment. When Payment Page is used for payment processing, the customer usually selects a bank while already in the payment form. When Payment Page is opened with the method and bank preselected as well as when payments are initiated through Gate, the bank must be selected on the side of the web service and the identifier of this bank must be specified in requests. Possible options for bank selection when working with Payment Page are described in Purchases by using Payment Page, ways of using bank identifiers—in the next subsection, Supported banks.

At the same time, different options for selecting a bank are supported for payments by using this method; they are described in the Purchases by using Payment Page section of this article.

Supported banks

The following table lists the names and identifiers of banks supported by the Indonesian Virtual Accounts method. Keep in mind that this list is presented for informational purposes.

Since the list of available banks may change over time, it is recommended to send a POST request to the /v2/info/banks/indonesia-va/sale/list endpoint to obtain up-to-date information. This endpoint belongs to the /v2/info/banks/{payment_method}/{operationType}/list group of the Gate API. The request must contain the project and payment identifiers, signature, currency code, and payment amount, as shown in the example. Specify real payment data if possible. However, random values are also allowed.

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

[
  {
    "id": 433, // Bank ID
    "abbr": "PMBVA", // Bank abbreviation (for internal use)
    "name": "Permata VA", // International bank name
    "nativeName": "Permata VA", // Local bank name
    "currencies": [ // Array with information about the currencies supported by the bank
      {
        "id": 982, // Currency ID in the payment platform
        "alpha_3_4217": "IDR", // ISO-4217 alphabetic currency code
        "number_3_4217": "360", // ISO-4217 numeric currency code
        "exponent": 2 // The number of decimal units of the currency
      }
    ]
  },
  {
    "id": 434, 
    "abbr": "MDRIVA", 
    "name": "Mandiri VA", 
    "nativeName": "Mandiri VA", 
    "currencies": [
      {
        "id": 982,
        "alpha_3_4217": "IDR",
        "number_3_4217": "360",
        "exponent": 2
      }
    ]
  },
  {
    "id": 2931, 
    "abbr": "BNIVA", 
    "name": "BNI Virtual Account", 
    "nativeName": "BNI VA", 
    "currencies": [
      {
        "id": 982,
        "alpha_3_4217": "IDR",
        "number_3_4217": "360",
        "exponent": 2
      }
    ]
  }
]

If you have any questions about working with banks supported by the Indonesian Virtual Accounts method, refer to your ecommpay account manager.

General information

To process a purchase through Payment Page by using the Indonesian Virtual Accounts 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 Indonesian Virtual Accounts 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 (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.

Information about the formats of requests and callbacks used for processing payments by using the Indonesian Virtual Accounts 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 Indonesian Virtual Accounts 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. 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—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 indonesia_va object containing the split_banks parameter with the value true:

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

   3. Selecting a bank among all available ones on Payment Page (3)—for this option specify the method code online-indonesian-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-indonesian-banks code in the force_payment_method parameter
      • the payment_methods_options object with the indonesia_va 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": "{\"indonesia_va\": {\"split_banks\": true, \"banks_id\": [2831, 2931]}}"

   5. Confirming redirection to the service of the specific bank on Payment Page (5)—for this option specify the following:
      • the online-indonesian-banks code in the force_payment_method parameter
      • the payment_methods_options object with the indonesia_va 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": "{\"indonesia_va\": {\"split_banks\": true, \"banks_id\": [2831]}}"

4. It may be necessary to specify the first and last names of the customer in the customer_first_name and customer_last_name parameters. Refer to your ecommpay key account manager for more information on the necessity of using these parameters.
5. Additionally, any other parameters available for working with Payment Page can be used (details).
6. After all target parameters are specified, generate a signature (details).

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_first_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_first_name": "Doe",
   "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": 1000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_first_name": "Doe",
   "force_payment_method": "online-indonesian-banks",
   "payment_methods_options": "{\"indonesia_va\": {\"split_banks\": true, \"banks_id\": [2831, 2931]}}",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The standard format for callbacks is used to deliver purchase results from Indonesian Virtual Accounts. For more information, see Handling 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 processing—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.
• Handling operation processing information—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 Indonesian Virtual Accounts 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 Indonesian Virtual Accounts 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 Indonesian Virtual Accounts 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 Indonesian Virtual Accounts method:

1. To initiate each purchase, send a separate POST request to the /v2/payment/banks/indonesia-va/sale endpoint. This endpoint belongs to the group /v2/payment/banks/{payment_method}/sale.
2. Each request must include the following objects and parameters:
   • Object general—general purchase 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—payment amount in the smallest currency unit. 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—payment 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 payment
   • Object account—customer account information:
     • bank_id—bank identifier
3. It may also be required to specify the first name and the last name of the customer in the corresponding parameters:
   • Object customer—customer information:
     • first_name—customer first name
     • last_name—customer last name
   • Object return_url—contains the URLs to which customer is redirected during or after payment processing:
     • return—URL to return customer to the web service during any step before the payment is completed

   Refer to your ecommpay key account manager for more information on the necessity of using these parameters.

4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Indonesian Virtual Accounts method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, URL for redirection, as well bank identifier as signature.

{
    "general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 35000000,
      "currency": "IDR"
    },
    "customer": {
      "id": "12345",
      "ip_address": "192.0.2.0"
      "first_name": "John",
      "last_name": "Doe"
    },
    "account":{
      "bank_id": 2961
    },
    "return_url": {
      "return": "https://example.com/return"
    }
 }

{
    "general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 35000000,
      "currency": "IDR"
    },
    "customer": {
      "id": "12345",
      "ip_address": "192.0.2.0"
      "first_name": "John",
      "last_name": "Doe"
    },
    "account":{
      "bank_id": 2961
    },
    "return_url": {
      "return": "https://example.com/return"
    }
 }

Formats of intermediate callbacks for customer redirection

Each payment made with the Indonesian Virtual Accounts method requires redirection of customers from the merchant's web service to the Indonesian Virtual Accounts service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

• body—object with data to be sent in the request body
• method—parameter specifying the HTTP method for sending the request (GET or POST)
• url—parameter containing a link for redirection

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final callback format

In the Indonesian Virtual Accounts method, the callbacks that deliver purchase results use the standard format described in Handling 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 processing—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 Gate.
• Handling operation processing information—about error and response codes that are used in the payment platform to record information about performing of operations.