ATM & Bank Transfer in Indonesia (Virtual Accounts)

Interaction diagram

Payment processing by using the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method requires merchant's web service, one of the interfaces and the payment platform of Monetix, as well the provider service.

Operations support

	Interfaces			Amounts, IDR
	Payment Page	Gate	Dashboard	minimum	maximum
Purchases				*	*

* For the most recent amount limits, refer to your Monetix Key Account Manager.

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) method, purchase can be performed either by redirecting customer to the provider service or by displaying the payment instructions to the customer. Refer to your Monetix key account manager for more information about workflow selection.

The sections that follow provide detailed information about what you need to perform payments and how you can analyze the information on payments and operations.

Supported banks

Payments with ATM & Bank Transfer in Indonesia (Virtual Accounts) are carried out through the banks that support this method. When using Payment Page, the customer generally selects a bank in the payment form, although in the payments that use Payment Page with the pre-selected payment method and bank or Gate, the customer must select the bank on the web service side and the request must contain the bank ID.

The tables below provide information about the supported banks. The list is provided for informational purposes only.

Note that the list of the supported banks may change without notice. To get the most recent list of the supported banks, use the Gate API to send a POST request to the /v2/info/banks/indonesia-va/sale/list endpoint at Gate API. The endpoint is a part of the /v2/info/banks/{payment_method}/{operationType}/list group of endpoints.

The following objects and parameters must be specified in the request for the list of supported banks:

• general—object with general request information:
  • project_id—the project ID obtained from Monetix
  • payment_id—payment ID, unique within the project
  • signature—signature created after all the parameters are collected. For more information about signature generation, see Signature generation and verification
• payment—object with payment information:
  • amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
  • currency—payment currency code in ISO-4217 alpha-3 format

Here is an example of the data from a request for the list of supported banks. 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"
  }
}

[
    {
        "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units)
        "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units)
        "limitCurrency": "IDR", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format
        "id": 123, // Bank ID
        "abbr": "EXB", // Bank shortcut name (for internal use)
        "name": "Example Bank", // General bank name
        "nativeName": "Example Bank", // Native bank name
        "currencies": [ // Array with currencies supported by the bank
            {
                "id": 123, // Currency ID in the payment platform
                "alpha_3_4217": "IDR", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
                "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
                "currency_type": "fiat", // Type of the currency
                "exponent": 2 // Number of decimal places after decimal point
            }
        ]
    }
]

General information

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform.

When opening Payment Page, you can have Payment Page opened with the ATM & Bank Transfer in Indonesia (Virtual Accounts) method pre-selected. (For more information about pre-selecting payment methods, see Preselecting payment methods.)

The full sequence of the purchase workflow is provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method and provide the information about the format of callbacks with payment results. For the general information about how to use the Payment Page API, see Payment Page API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • customer_id—unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email address
   • 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 Monetix 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.)

     If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

2. There are several options to customize the payment method selection page on Payment Page.
   • Bank selection in two steps This option is used by default. The banks that support ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method are grouped in one button on Payment Page, therefore the bank selection is carried out in two steps. On the first step, the ATM & Bank Transfer in Indonesia (Virtual Accounts) method is chosen among others, and then, on the second step, the particular bank is selected on the next page with the list of the group banks.
   • Display each bank as a separate button along with other payment methods To show each bank of the ATM & Bank Transfer in Indonesia (Virtual Accounts) group as a separate button, set the split_banks parameter in the payment_methods_options string to true.

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

   • Show the banks of only one payment method To show only the banks available in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method on Payment Page for customers, pass the code indonesia-va in the force_payment_method parameter. The customer will see only the banks available in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method.
   • Show only selected banks To display a button of specific banks (one or several) from ATM & Bank Transfer in Indonesia (Virtual Accounts) group on Payment Page in the list of payment methods, set force_payment_method to indonesia-va and add an array with IDs of the banks to show on Payment Page in the banks_id parameter. Here an example:

     payment_methods_options={"indonesia_va": {"split_banks": true, "banks_id": [499, 436]}}

     Here is an example of a request to open Payment Page with the specific pre-selected bank:

     EPayWidget.run(
         {
             project_id: 1234,
             payment_id: 'payment_47',
             customer_id: 'customer_123',
             customer_first_name: 'John',
             customer_last_name: 'Doe',
             customer_email: 'johndoe@example.com',
             payment_currency: 'IDR',
             payment_amount: 20000000,
             force_payment_method: 'indonesia-va',
             payment_methods_options: {"indonesia_va": {"banks_id": [499]}},
             signature: 'kUi2x9dKHAVNU0FY...vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=='
         }
     )

3. You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
4. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign payment requests, see Signature generation and verification.

Here is an example of the data from a request for the Payment Page opening:

EPayWidget.run(
    {
        project_id: 1234, 
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@email.com',
        payment_currency: 'IDR',
        payment_amount: 20000000,
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=='
    }
)

Callback format

The ATM & Bank Transfer in Indonesia (Virtual Accounts) method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Payment Page.

The following is an example of a callback with information about a successful 200,000.00 IDR purchase.

 {
        "project_id": 1234,
        "payment": {
            "id": "payment_123",
            "type": "purchase",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "8856113600001045"
        },
        "customer": {
            "id": "customer_123"
        },
        "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": 12345,
                "payment_id": "123456",
                "auth_code": "",
                "date": "2020-02-22T22:44:45+0000"
            }
        },
        "signature": "Hekd6+86S592dGuYCHNLADZ8LaBC5/JSKObUxTvkUuCZL4phAiFQA=="
    }

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

{
        "project_id": 1234,
        "payment": {
            "id": "payment_123",
            "type": "purchase",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 1000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "8856113600001046"
        },
        "customer": {
            "id": "customer_123"
        },
        "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:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform.

When opening Payment Page, you can have Payment Page opened with the ATM & Bank Transfer in Indonesia (Virtual Accounts) method pre-selected. (For more information about pre-selecting payment methods, see Preselecting payment methods.)

The full sequence of the purchase workflow is provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method and provide the information about the format of callbacks with payment results. For the general information about how to use the Payment Page API, see Payment Page API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
   • project_id—project ID you obtained from Monetix
   • payment_id—payment ID, unique within the project
   • customer_id—unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email address
   • 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 Monetix 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.)

     If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

2. There are several options to customize the payment method selection page on Payment Page.
   • Bank selection in two steps This option is used by default. The banks that support ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method are grouped in one button on Payment Page, therefore the bank selection is carried out in two steps. On the first step, the ATM & Bank Transfer in Indonesia (Virtual Accounts) method is chosen among others, and then, on the second step, the particular bank is selected on the next page with the list of the group banks.
   • Display each bank as a separate button along with other payment methods To show each bank of the ATM & Bank Transfer in Indonesia (Virtual Accounts) group as a separate button, set the split_banks parameter in the payment_methods_options string to true.

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

   • Show the banks of only one payment method To show only the banks available in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method on Payment Page for customers, pass the code indonesia-va in the force_payment_method parameter. The customer will see only the banks available in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method.
   • Show only selected banks To display a button of specific banks (one or several) from ATM & Bank Transfer in Indonesia (Virtual Accounts) group on Payment Page in the list of payment methods, set force_payment_method to indonesia-va and add an array with IDs of the banks to show on Payment Page in the banks_id parameter. Here an example:

     payment_methods_options={"indonesia_va": {"split_banks": true, "banks_id": [499, 436]}}

     Here is an example of a request to open Payment Page with the specific pre-selected bank:

     EPayWidget.run(
         {
             project_id: 1234,
             payment_id: 'payment_47',
             customer_id: 'customer_123',
             customer_first_name: 'John',
             customer_last_name: 'Doe',
             customer_email: 'johndoe@example.com',
             payment_currency: 'IDR',
             payment_amount: 20000000,
             force_payment_method: 'indonesia-va',
             payment_methods_options: {"indonesia_va": {"banks_id": [499]}},
             signature: 'kUi2x9dKHAVNU0FY...vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=='
         }
     )

3. You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
4. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign payment requests, see Signature generation and verification.

Here is an example of the data from a request for the Payment Page opening:

EPayWidget.run(
    {
        project_id: 1234, 
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@email.com',
        payment_currency: 'IDR',
        payment_amount: 20000000,
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=='
    }
)

Callback format

The ATM & Bank Transfer in Indonesia (Virtual Accounts) method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Payment Page.

The following is an example of a callback with information about a successful 200,000.00 IDR purchase.

 {
        "project_id": 1234,
        "payment": {
            "id": "payment_47",
            "type": "purchase",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "8854321000001234"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 54321000012345,
            "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 declined purchase.

{
        "project_id": 1234,
        "payment": {
            "id": "payment_47",
            "type": "purchase",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "8854321000001234"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 54321000012345,
            "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": 20000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "code": "20000",
            "message": "General decline",
        },
        "signature": "Hekd6+86S592dGuYCHNLADZ8LaBC5/JSKObUxTvkUuCZL4phAiFQA=="
    }

Related topics

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

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) method, the merchant web service is required to do the following when processing a purchase by using Gate:

1. Send a request with all the required parameters and signature to the Monetix URL.
2. Redirect the customer to the page with a payment instructions.
3. Accept the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method and provide the information about the format of callbacks with purchase results. For the general information on how to use the Gate API, see API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method:

1. You initiate a purchase by submitting a purchase request to the /v2/payment/banks/indonesia-va/sale endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints: /v2/payment/banks/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general purchase information:
     • project_id—the project ID you obtained from Monetix
     • payment_id—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.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email address
   • payment—object with payment details:
     • 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 Monetix 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).

       If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

     • currency—code of the purchase currency in the ISO-4217 alpha-3 format
   • account—object with customer account information:
     • bank_id—bank identifier
3. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • success—the URL to redirect the customer to after the payment is successfully completed.
     • decline—the URL to redirect the customer to after the payment is declined.
     • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
4. If required, you can add any other additional (optional) parameters Gate supports.

Here is an example of the data from a purchase request in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method.

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id":"customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account":{
        "bank_id": 499
    },
    "payment": {
        "amount": 20000000,
        "currency": "IDR"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the provider service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

• url—the URL to redirect the customer to
• body—the data to be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "POST",
    "body": {
        "example_parameter_1": "value_1",
        "example_parameter_2": "value_2"
    },
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The ATM & Bank Transfer in Indonesia (Virtual Accounts) method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Gate.

The following is an example of a callback with information about a successful 200,000.00 IDR purchase.

 {
        "project_id": 1234,
        "payment": {
            "id": "9770802",
            "type": "purchase",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "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 declined due to the exceeded amount limit.

{
        "project_id": 1234,
        "payment": {
            "id": "9770802",
            "type": "purchase",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 1000,
                "currency": "IDR"
            },
            "description": ""
        },
        "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:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) method, the merchant web service is required to do the following when processing a purchase by using Gate:

1. Send out a request with all the required parameters and signature to the Monetix URL.
2. Display the page with payment instructions to the customer.
3. Accept callback with payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method and provide the information about the format of callbacks with purchase results. For the general information on how to use the Gate API, see API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method:

1. You initiate a purchase by submitting a purchase request to the /v2/payment/banks/indonesia-va/sale endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints: /v2/payment/banks/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general purchase information:
     • project_id—the project ID you obtained from Monetix
     • payment_id—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.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • payment—object with 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 Monetix 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).

       If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

     • currency—code of the purchase currency in the ISO-4217 alpha-3 format
   • account—object with customer account information:
     • bank_id—bank identifier
3. If required, you can add any other additional (optional) parameters Gate supports.

Here is an example of the data from a purchase request in the ATM & Bank Transfer in Indonesia (Virtual Accounts) method.

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id":"customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account":{
        "bank_id": 499
    },
    "payment": {
        "amount": 20000000,
        "currency": "IDR"
    }
}

Format of payment instruction data

Before displaying the screen with payment instructions to the customer, you must accept a callback from the payment platform with the payment data in the display_data array—only after this you can display the screen with payment instructions to the customer.

Each element of the display_data array contains the following parameters:

• type—data type, the value is always add_info
• title—name of the payment instruction components. Possible values:
  • invoice_number—payment number
  • virtual_account_number—virtual account number of payment recipient
  • request_amount—payment amount
  • request_currency—payment currency code
  • expired_date—payment expiration deadline. Specified in Unix time.
• data—payment instruction details.

Examples of payment instructions by using different payment ways through some Indonesian banks are shown in the file you can download here. Before displaying these instructions to the customer, replace the data in the instructions with the actual data you received in the display_data array.

The following example of callback code contains the data for displaying to the customer.

"display_data": [
    {
        "type": "add_info",
        "title": "invoice_number",
        "data": "12345678987654"
    },
    {
        "type": "add_info",
        "title": "virtual_account_number",
        "data": "8889940000012345"
    },
    {
        "type": "add_info",
        "title": "request_amount",
        "data": "200000"
    },
    {
        "type": "add_info",
        "title": "request_currency",
        "data": "IDR"
    },
    {
        "type": "add_info",
        "title": "expired_date",
        "data": "1648190569"
    }
]

Callback format

The ATM & Bank Transfer in Indonesia (Virtual Accounts) method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Gate.

The following is an example of a callback with information about a successful 200,000.00 IDR purchase.

 {
        "project_id": 1234,
        "payment": {
            "id": "9770802",
            "type": "purchase",
            "status": "success",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "8854321000001234"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 54321000012345,
            "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 declined purchase.

{
        "project_id": 1234,
        "payment": {
            "id": "9770802",
            "type": "purchase",
            "status": "decline",
            "date": "2020-02-22T22:44:46+0000",
            "method": "indonesia-va",
            "sum": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "account": {
            "number": "8854321000001234"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 54321000012345,
            "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": 20000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 20000000,
                "currency": "IDR"
            },
            "code": "20000",
            "message": "General decline",
        },
        "signature": "Hekd6+86S592dGuYCHNLADZ8LaBC5/JSKObUxTvkUuCZL4phAiFQA=="
    }

Related topics

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

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

You can perform test purchases with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method by using Payment Page and Gate.

To perform test purchases, you'll need the test project ID and the secret key to it. To get them, please contact the technical support team at support@monetix.pro and then contact your Monetix key account manager to set up a test environment to work with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

When performing test payments, keep in mind that:

• your requests must contain the test project ID
• the payment currency that you send in requests can be only IDR
• random values may be used as the payment ID and in the parameters with customer information
• the interface of the test checkout page may be different from the production one.

Test payments statuses

To receive one of the following statuses in the callback with the test purchase result, use a particular value for the purchase amount in the request:

• 40000 and 40400—to receive a callback with the decline status
• any other value—to receive a callback with the success status

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

1. Send a request for purchase through Payment Page to the payment platform.
2. Choose a payment method on the test checkout page. If you've passed the force_payment_method parameter with the indonesia-va value in the request, you won't have to choose the payment method.
3. Specify a random first name and last name in the data entry fields. The payment instructions will be displayed to you after.
4. Accept a callback with information about the test purchase result.
5. Wait a few seconds until the result of the test purchase is displayed to you on the test checkout page.

See the detailed information about purchase processing through Payment Page in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method in the Purchase by using Payment Page section.

Testing purchase by using Gate

To perform a test purchase by using Gate:

1. Send a request for performing a test purchase to the payment platform.
2. Accept a callback with the data for displaying payment instructions. Your system will display the payment instructions to you after.
3. Accept a callback with information about the test payment result.
4. Wait a few seconds until your system shows you the result of the test purchase.

See the detailed information about purchase processing through Gate in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method in the Purchase by using Gate section.

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• 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 means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.