Banks of Indonesia

Overview

Banks of Indonesia is a payment method that uses the online banking mechanism for payments through Indonesian banks. You can perform purchases through this method by using Payment Page and Gate, payouts by using Gate.

General information

Payment method type Online banking
Countries and regions Indonesia
Payment currencies IDR
Currency conversion
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
  • Cascade payment processing is supported for working with this method by using Payment Page. For more information, see Cascade payment processing or contact your ECommPay key account manager
  • Banks of Indonesia is one of the Southeast Asia bank groups and has some particularities when opening Payment Page
  • With this method, all payment amounts are integer. In case of a non-integer payment, the fractional part is rounded up
  • Two ways of selecting bank for payment are supported: on the Payment Page side and on the provider side. For more information refer to the ECommPay key account manager
  • Safari browser may not support the redirection to a bank service. For more information refer to the ECommPay key account manager
Onboarding and access fee Refer to your ECommPay key account manager
Note:

Two technical implementations are currently supported for working with the Banks of Indonesia method: the new one described in this section and the old one described in the section Banks of Indonesia (legacy).

Details about the difference between these implementations and how to switch from the old implementation to the new one should be clarified with the ECommPay key account manager.

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

  Interfaces Amounts *, IDR Times **
Payment Page CMS Plug-ins Gate Dashboard Minimum Maximum Basic Threshold
Purchases + + * * up to 5 minutes 48 hours
Payouts + * * up to 10 minutes 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 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.

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 Purchase Payout
Bank Artha Graha 512 +
Bank BCA Syariah 555 +
Bank Bukopin 549 +
Bank Central Asia 140 + +
Bank Centratama Nasional 557 +
Bank Chinatrust Indonesia 566 +
Bank CIMB Niaga 507 +
Bank Commonwealth 567 +
Bank Danamon Indonesia 398 + +
Bank Danamon Syariah 558 +
Bank DBS Indonesia 514 +
Bank Hana 551 +
Bank HSBC 513 +
Bank International Indonesia (BII MayBank) 505 +
Bank Jabar Banten Syariah 546 +
Bank Mandiri 143 + +
Bank Mayapada International 519 +
Bank MayBank Indonesia 565 +
Bank MayBank Indonesia Syariah 559 +
Bank Mayora 556 +
Bank Mega 547 +
Bank Muamalat Indonesia 539 +
Bank Mutiara 518 +
Bank Nagari (BPD Sumbar) 526 +
Bank National Nobu 553 +
Bank Negara Indonesia 141 + +
Bank Negara Indonesia Syariah 548 +
Bank NTT 537 +
Bank Nusantara Parahyangan 538 +
Bank OCBC NISP 509 +
Bank Panin 506 +
Bank Permata 396 + +
Bank Permata Syariah 560 +
Bank Rakyat Indonesia 142 + +
Bank Rakyat Indonesia Syariah 545 +
Bank Saudara 543 +
Bank Sinarmas 540 +
Bank Sinamars Syariah 562 +
Bank Standard Chartered 515 +
Bank Sumut 525 +
Bank Syariah Mandiri 550 +
Bank Syariah Mega 554 +
Bank Tabungan Negara (BTN) 399 + +
Bank Tabungan Pensiunan Nasional /BTPN 544 +
Bank Tabungan Negara Syariah (BTN) 561 +
Bank UOB Buana Indonesia 508 +
Bank Windu Kencana 511 +
BPD Aceh 524 +
BPD BALI 536 +
BPD Jawa Barat (Bank BJB) 520 +
BPD Jawa Tengah 522 +
BPD Jawa Timur (Bank JATIM) 523 +
BPD Kalimantan Barat 531 +
BPD Kalimantan Selatan 530 +
BPD Kalimantan Timur 532 +
BPD Lampung 529 +
BPD Nusa Tenggara Barat 535 +
BPD Riau 527 +
BPD Sulawesi Selatan dan Barat 533 +
BPD Sulawesi Utara 534 +
BPD Sumatera Selatan 528 +
BPD Yogyakarta 521 +
CIMB Clicks Indonesia 397 + +
CIMB Niaga (CIMBN) 507 + +
CITIBank 510 +
Deutsche Bank AG 516 +
DOKU 564 +
ICB Bumiputera 552 +
OCBC NISP Syariah 563 +
Permata Bank (PMB) 396 + +
QNB Kesawan 541 +
RaboBank 517 +
Virtual Account Bank 400 +

Payout regions

When performing payouts through the Banks of Indonesia method, the region of the customer bank account must be passed in the region_id parameter in the request for payout. The following table provides information about the regions and identifiers.

Table 2. List of regions
Region name Region ID
Aceh 236
Bali 237
Banten 238
Bengkulu 239
Gorontalo 240
Jakarta Raya 241
Jambi 242
Jawa 243
Jawa Barat 244
Jawa Tengah 245
Jawa Timur 246
Kalimantan 247
Kalimantan Barat 248
Kalimantan Selatan 249
Kalimantan Tengah 250
Kalimantan Timur 251
Kalimantan Utara 252
Kepulauan Bangka Belitung 253
Kepulauan Riau 254
Lampung 255
Maluku (region) 256
Maluku (province) 257
Maluku Utara 258
Nusa Tenggara 259
Nusa Tenggara Barat 260
Nusa Tenggara Timur 261
Papua (region) 262
Papua (province) 263
Papua Barat 264
Riau 265
Sulawesi 266
Sulawesi Barat 267
Sulawesi Selatan 268
Sulawesi Tengah 269
Sulawesi Tenggara 270
Sulawesi Utara 271
Sumatera 272
Sumatera Barat 273
Sumatera Selatan 274
Sumatera Utara 275
Yogyakarta 276

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

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 Payment Page side

  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 Banks of Indonesia group and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  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 bank service.
  10. The purchase request is processed on the bank service side.
  11. The bank 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 bank website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the bank side.
  16. The result is displayed to the customer on the bank website.
  17. The customer is redirected to Payment Page.
  18. The bank service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

Figure: Purchase sequence by using Payment Page with bank selection on the provider side



Figure: Purchase sequence by using Payment Page with bank selection on the provider side

  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 the Banks of Indonesia method and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  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 service side.
  11. The provider service generates the data for redirecting the customer to the bank selection page 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 bank selection page.
  14. The customer selects bank for payment.
  15. The customer is redirected to the bank site.
  16. The bank payment form is displayed to the customer.
  17. The customer completes all the payment steps required.
  18. The payment is processed on the bank side.
  19. The result is displayed to the customer on the bank website.
  20. The bank service sends the result notification to the provider service.
  21. The provider service sends the result notification to the payment platform.
  22. The payment platform sends a callback with the payment result to the web service.
  23. The payment platform sends the result to Payment Page.
  24. 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 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.

The operation.sum_converted.amount parameter indicates the amount in major currency units converted and/or rounded up.

Here is the example of a callback with an information about successful 200 000,00 IDR purchase made by the 1 customer in the 200 project.

Figure: Example of a succeed purchase callback

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_154383173598055",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T10:50:29+0000",
            "method": "Indonesian banks",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": "TEST_1543831735980"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 15788000002076,
            "type": "sale",
            "status": "success",
            "date": "2018-12-03T10:50:29+0000",
            "created_date": "2018-12-03T10:40:20+0000",
            "request_id": "72cb91e7586004",
            "sum_initial": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 200000,
                "currency": "IDR"
            },
            "provider": {
                "id": 1153,
                "payment_id": "",
                "date": "2018-12-03T10:44:27+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Cug4rIB6OimEkwmMBi1OfYpapSpZrz00eNLNIwE/eugWYrFyBErmi0OVw34WpHt5CzEA=="
    }

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": "TEST_154356886034811111",
            "type": "purchase",
            "status": "decline",
            "date": "2018-11-30T14:11:13+0000",
            "method": "Indonesian banks",
            "sum": {
                "amount": 1000,
                "currency": "IDR"
            },
            "description": "TEST_154356886034811111"
        },
        "operation": {
            "id": 9830000002095,
            "type": "sale",
            "status": "decline",
            "date": "2018-11-30T14:11:13+0000",
            "created_date": "2018-11-30T14:11:06+0000",
            "request_id": "3b14e5b0fd1",
            "sum_initial": {
                "amount": 1000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 10,
                "currency": "IDR"
            },
            "provider": {
                "id": 1153,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5SwH8wQubo0+7RCZWuxc0feItZRcABrPdFA4EKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

Related topics

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

Purchase by using Gate

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 site

  1. A customer initiates a purchase through one of the Banks of Indonesia group banks 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 bank service.
  7. The request is processed on the bank side.
  8. The bank service sends the data for redirecting the customer to the selected bank 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 from the web service to the selected bank website.
  11. The customer completes all the payment steps required on the bank website.
  12. The payment is processed on the bank side.
  13. The result is displayed to the customer on the bank website.
  14. The customer is redirected to the merchant's web service.
  15. The bank service sends the payment result notification to the payment platform.
  16. The ECommPay payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

Figure: Purchase sequence by using Gate with redirection to the bank selection page



Figure: Purchase sequence by using Gate with redirection to the bank selection page

  1. A customer initiates a purchase through one of the Banks of Indonesia group banks 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 customer redirection to the bank selection page to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected from website to the bank selection page.
  11. The customer selects bank for payment.
  12. The customer is redirected to the bank site.
  13. The bank payment form is displayed to the customer.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the bank side.
  16. The result is displayed to the customer on the bank website.
  17. The customer is redirected to the merchant's web service.
  18. The bank service sends the payment result notification to the provider service.
  19. The provider service sends the payment result notification to the payment platform.
  20. The ECommPay payment platform sends a callback to the web service.
  21. The customer receives the payment result on the web service.

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

There are several things you must consider when using purchase requests in the Banks of Indonesia method:
  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 Additional payment information submission.
  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:

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

Figure: The callback fragment containing the token for purchase


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

Figure: The callback fragment containing the URL for redirection to the selected bank site


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

The operation.sum_converted.amount parameter indicates the amount in major currency units converted and/or rounded up.

The following is the example of a callback with the information about successful 200,000.00 IDR purchase made by the 1 customer in the 200 project.

Figure: Example of a succeed purchase callback

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_154383173598055",
            "type": "purchase",
            "status": "success",
            "date": "2018-12-03T10:50:29+0000",
            "method": "Indonesian banks",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": "TEST_1543831735980"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 15788000002076,
            "type": "sale",
            "status": "success",
            "date": "2018-12-03T10:50:29+0000",
            "created_date": "2018-12-03T10:40:20+0000",
            "request_id": "72cb91e7586004",
            "sum_initial": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 200000,
                "currency": "IDR"
            },
            "provider": {
                "id": 1153,
                "payment_id": "",
                "date": "2018-12-03T10:44:27+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Cug4rIB6OimEkwmMBi1OfYpapSpZrz00eNLNIwE/eugWYrFyBErmi0OVw34WpHt5CzEA=="
    }

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": "TEST_154356886034811111",
            "type": "purchase",
            "status": "decline",
            "date": "2018-11-30T14:11:13+0000",
            "method": "Indonesian banks",
            "sum": {
                "amount": 1000,
                "currency": "IDR"
            },
            "description": "TEST_154356886034811111"
        },
        "operation": {
            "id": 9830000002095,
            "type": "sale",
            "status": "decline",
            "date": "2018-11-30T14:11:13+0000",
            "created_date": "2018-11-30T14:11:06+0000",
            "request_id": "3b14e5b0fd1",
            "sum_initial": {
                "amount": 1000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 10,
                "currency": "IDR"
            },
            "provider": {
                "id": 1153,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "cQbMiD0pON9eJc5ZugNK0iT5SwH8wQubo0+7RCZWuEKQiyWj7NWQRmVyHzNTmOX6Zg5w=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Payout by using Gate

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.



Figure: Payout sequence by using Gate

  1. A customer orders a payout through one of the supported banks from Banks of Indonesia group.
  2. Merchant's web service sends the payout request for processing the payout by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary check and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the Banks of Indonesia service.
  7. The payout is processed on the bank side.
  8. Banks of Indonesia sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the payout result from the web service.

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

There are several things you must consider when using payout requests in the Banks of Indonesia method:
  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
      • first_name*—customer first name
      • last_name*—customer last name
      • email*—email address
      • ip_address—customer IP address
    • Object account—customer account information:
      • number—customer account number
      • customer_name* — name of bank account holder
      • bank_id—bank identifier
      • branch—bank branch identifier
      • city—bank branch city
      • customer_name—bank account holder's name
      • region_id—region identifier
    • 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.
    Note: * Consult with the ECommPay key account manager about necessity of these parameters in the payout request. Depending on the payment processing provider, other mandatory parameters may be required to complete the payout. For the list of all mandatory parameters, contact your ECommPay key account manager.
  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) and its region, customer IP address, currency and amount of the payout, as shown in the following example:

Figure: Payout request example

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

Callback format

In the Banks of Indonesia method, the callbacks that deliver payout results use the standard format described in Callbacks.

The operation.sum_converted.amount parameter indicates the amount in major currency units converted and/or rounded up.

The following is the example of a callback with the information about successful 200,000.00 IDR payout made to account 035209875690435 of the 1 customer in the 200 project.

Figure: Example of a successful payout callback

 {
        "project_id": 200,
        "payment": {
            "id": "TESTPAYOUT7891022555",
            "type": "payout",
            "status": "success",
            "date": "2018-12-12T13:28:58+0000",
            "method": "Indonesian banks",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": "test payout"
        },
        "account": {
            "number": "6419422222",
            "bank_id":140,
            "region_id": 236
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 15112000002236,
            "type": "payout",
            "status": "success",
            "date": "2018-12-12T13:28:58+0000",
            "created_date": "2018-12-12T13:22:15+0000",
            "request_id": "b54610e94a76",
            "sum_initial": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 200000,
                "currency": "IDR"
            },
            "provider": {
                "id": 1153,
                "payment_id": "E80NPPQ6Z1YSYPZTPH0NBON42",
                "date": "2018-12-12T13:28:34+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qV2FRs/wxoOaywQS0GYQDi+6spZFbiRXxt8zG
                            10zy9TNiJLT0P/+EOrpMkoW80mynkaQfSAUJpfQ=="
    }

The following is the example of a callback for a payout rejected due to exceeding the limit of the payout amount.

Figure: Example of a declined payout callback

{
        "project_id": 200,
        "payment": {
            "id": "TESTPAYOUT789",
            "type": "payout",
            "status": "decline",
            "date": "2018-12-07T09:44:43+0000",
            "method": "Indonesian banks",
            "sum": {
                "amount": 5000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "6419422222",
            "bank_id":140,
            "region_id": 236
        },
        "customer": {
            "id": "1"
        },
        "errors": [
            {
                "code": "3104",
                "message": "Payment Constraint Invalid Payout Amount",
                "description": "Gate. Operation was declined. Maximum payout limit is exceeded"
            }
        ],
        "operation": {
            "id": 533000002202,
            "type": "payout",
            "status": "decline",
            "date": "2018-12-07T09:44:43+0000",
            "created_date": "2018-12-07T09:44:43+0000",
            "request_id": "205d3536a91f4737d679ae44f5c707eaace0b
                                009-7b37cb0b1b4d62a602dd42fa7d248258224fe3f6",
            "sum_initial": {
                "amount": 5000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 50,
                "currency": "IDR"
            },
            "provider": {
                "id": 1153,
                "payment_id": ""
            },
            "code": "3104",
            "message": "Payment Constraint Invalid Payout Amount"
        },
        "signature": "j4cxKDvx0EaDe4zKLbLcb8isoHFxBB/eV5hPzvsN+iFpGJELstSJw0bHot6v83rzDMlinxE915lAWGHKVjurpQ=="
    }

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