Banks of Indonesia

General information

Interaction diagram

Payment processing by using the Banks of Indonesia 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

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

Processing scenarios

In the Banks of Indonesia 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 Indonesia 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/indonesia/sale/list to receive the list of banks supporting purchase performing or /v2/info/banks/indonesia/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.

{
  "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 Banks of Indonesia 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 Banks of Indonesia methods from the list of other payment methods on Payment Page or have Payment Page opened with one of the Banks of Indonesia method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

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

The sections that follow provide details the request format and the Payment Page parameters to use in the Banks of Indonesia 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 Banks of Indonesia 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—rounded up integer purchase amount in minor currency units
2. There are more mandatory parameters for this method:
   • first_name—first name
   • last_name—last name
   • email—email address
3. By default Payment Page is opened in English language. To change the language of Payment Page and payment page of the Banks of Indonesia service pass language code in the language_code parameter in the request for opening. The list of supported languages for the Banks of Indonesia 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. The currency of payment can only be IDR.
5. To open Payment Page in the language of the bank group, pass the id code in the language_code parameter in the request for opening. For more information, see Interface language support.

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

   By default, banks that support Banks of Indonesia 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 Indonesia 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-indonesian-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 Indonesia 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 Indonesia group with a separate buttons, pass split_banks=true in the request for opening in the payment_methods_options string.

     payment_methods_options={"online_indonesian_banks": {"split_banks": true}}
     

   • To display a button of a specific bank (one or several) from Banks of Indonesia 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_indonesian_banks": {"split_banks": true, "banks_id": [140, 141]}}

   • To preselect Banks of Indonesia as the payment method on Payment Page for customers, pass the code online-indonesian-banks in the force_payment_method parameter in the request for opening. The list of the banks from Banks of Indonesia 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 Indonesia group, pass the code online-indonesian-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: 20000000, 
           payment_currency: 'IDR', 
           project_id: 0,
           customer_id: 'user123',
           force_payment_method: 'online-indonesian-banks',
           payment_methods_options={"online_indonesian_banks": {"banks_id": [140]}},
           signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ
                             9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
         }
     )

7. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Banks of Indonesia method, see Payment Page invocation parameters.
8. 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 Indonesia 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: 20000000, 
      payment_currency: 'IDR', 
      project_id: 0,
      customer_id: '1',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

The standard format for callbacks is used to deliver purchase results from Banks of Indonesia. 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 Banks of Indonesia 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 Indonesia 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 selection page

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

1. You perform purchase by sending the /v2/payment/banks/indonesia/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—rounded up integer purchase amount in minor currency units
     • 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
   • Object return_url—URLs for redirecting a customer from the bank website:
     • success—URL for redirecting a customer after a performed purchase
     • decline —URL for redirecting a customer after a declined purchase
3. By default the payment page of the Banks of Indonesia 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 Indonesia 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 Submission of additional payment information.
5. The currency of a purchase can only be IDR. The amount should be integer, the fractional part should be rounded up. On the merchant side, customers should be warned about rounding.
6. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Banks of Indonesia method must include project, payment, customer, and bank IDs, customer IP-address, signature, currency and amount of the purchase, and the return URL, 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":"2990",
      "ip_address": "248.121.176"
    },
    "account":{
      "bank_id": 140
    },
    "return_url":{
      "decline" : "http://return.url",
      "success" : "http://return.url"
    }
}

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.

"redirect_data": {
              "method": "POST",
              "body": {
                "token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJwYXiIwLjEifQ.xAQWCKO-
                          cZ7yRT_n0MjQ3MjY3NSwiaWgwMDk1LCJqdGkiOha2Rt4Cm5IRvoP1oP
                          N2mNOzVWp7LcHgDXa64ah4DtQsMRzrVFTwkiOha2Rt4Cm5IF0IjoxNTQ"
            },
             "encrypted": [],
             "url": "https://payment.allpay.site/api/transfer/v1/payIn/sendTokenForm"
    }

 "redirect_data": {
                    "body": {
                        "amount": "200000.00",
                        "currency": "IDR"
                    },
                    "method": "POST",
                    "url": "https://secure.example.asia/"
                }
            }

Callback format

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

General information

To perform a payout through the Banks of Indonesia 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.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Banks of Indonesia payment method and provide the information on the format of callbacks with payout results.

Request format

1. You perform payouts by sending the /v2/payment/banks/indonesia/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
     • email*—email address
     • ip_address—customer IP address
   • Object account—customer account information:
     • number—customer account number
     • bank_id—bank identifier
     • customer_name—bank account holder's name
   • Object payment—payout information:
     • amount—rounded up integer payout amount in minor currency units (payment with fractional payout amount will be declined by the provider)
     • currency—payout currency in ISO-4217 alpha-3 format.
3. The currency of payout can only be IDR.
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 Indonesia method must include project, payment, customer, and bank IDs, account number (for crediting), customer IP address, currency and amount of the payout, as shown in the following example:

{
    "general": {
        "project_id": 2990,
        "payment_id": payment_id,
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7aRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 35000000,
      "currency": "IDR"
      },
    "customer": {
      "id":"2990",
      "ip_address": "248.121.176"
    },
    "account":{
      "bank_id": 140,
      "customer_name": "Putra account",
      "number": "314159265358979"
    }
}

Callback format

In the Banks of Indonesia method, the callbacks that deliver payout 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

General information

For the Banks of Indonesia method the testing of purchases by using Payment Page and Gate as well as payouts by using Gate.

Testing can be performed within a test project, to enable and disable the testing availability, contact ecommpay technical support via support@ecommpay.com.

When performing a test payment, take into account that you must specify the identifier of the test project in the requests, the interfaces of the payment forms emulator of Payment Page and Banks of Indonesia differ from the production environment.

Test payments statuses

When testing purchases, the final payment status is determined by the amount specified in the request:

• decline status with 40000 or 40400 amount
• success status with any other amount

When testing payouts, the final payment status is determined by the amount specified in the request:

• decline status with 40000 or 40400 amount
• success status with any other amount

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-indonesian-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. Accept a callback with information about the payment result.

The full information about purchase process by using Banks of Indonesia through Payment Page is provided in the section Purchase by using Payment Page.

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

The full information about purchase process by using Banks of Indonesia through Gate is provided in the section Purchase by using Gate.

Payouts by using Gate

To perform a test payout by using Gate, send a correct test request to the payment platform and accept a callback with information about the payment result. The full information about payout process by using Banks of Indonesia through Gate is provided in the section Payout by using Gate.

As with other payment methods ecommpay offers, when using the Banks of Indonesia 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.