Scenario 1. Purchase with customer redirection

When performing a purchase, the customer is redirected to the provider service where they make a purchase.

Countries and regions Indonesia
Payment currencies IDR
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.
Special considerations
  • The payment amount in IDR must be strictly integer.

    In requests, the payment amount must be specified only in minor currency units! For example, a 95.00 IDR payment amount must be submitted as 9500 in the request. You can check the number of digits for minor currency units for any currency in Currency codes.

  • If you specify a different payment currency in your request, the Monetix payment platform will convert the payment amount into IDR and round it up to the nearest integer.

Operations support

Interfaces
Payment Page Gate Dashboard
Purchase

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 then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page
  1. The customer initiates a purchase in your system.
  2. Your system sends the request for the purchase through Payment Page to the Monetix URL.
  3. The checkout page is displayed to the customer.
  4. The customer chooses to make a purchase with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.
  5. The payment platform processes the request and forwards it to the provider service.
  6. The provider service sends the customer redirection data to the payment platform.
  7. The checkout page redirects the customer to the provider service.
  8. The customer completes the purchase.
  9. The provider service sends the purchase result information to the payment platform.
  10. The payment platform sends a callback with the payment result to your system.
  11. The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

Table 1. Basic parameters of requests to Payment Page

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.
ParameterDescription

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: IDR

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 IDR must be sent as 10000

force_payment_method
string
optional

Parameter that allows you to enforce the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method for your customer and skip the page with payment method selections.

To enforce the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to indonesia-va. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'indonesia-va'

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

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: 10000,
		force_payment_method: 'indonesia-va',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Displaying bank icons on the checkout page

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method, the payments are performed through specific banks. When making a purchase on the checkout page, the customer first chooses a payment method and then selects the bank.

The ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method offers several options to display bank icons on the checkout page:

  • Choosing the bank in two steps First, the customer chooses ATM & Bank Transfer in Indonesia (Virtual Accounts) among other payment methods, and then selects the bank from the list. This is the default behavior.
  • Displaying banks alongside other payment methods To display banks as separate buttons on the checkout page alongside the other payment methods, add the payment_methods_options object with the split_banks parameter to the request and set the value of this parameter to true.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"indonesia_va": {"split_banks": true}}
  • Displaying only banks of the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method For the customer to see only banks available in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method (without other payment methods), add the force_payment_method parameter to the request and set it to indonesia-va.
  • Displaying only specific banks To show the customer only specific banks available in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method, use the force_payment_method parameter with the indonesia-va value in the request, add the payment_methods_options object with the split_banks parameter and set this parameter to true. Next, specify the IDs of the banks to display in the banks_id array.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

    payment_methods_options={"indonesia_va": {"split_banks": true, "banks_id": [140, 141]}}

    Here is an example of the data from a request with preselected banks to open the checkout page with EPayWidget.

    Figure 2. Example of the data from a request to open the checkout page with preselected banks
    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: 10000,
        force_payment_method: 'indonesia-va',
        payment_methods_options: '{"indonesia_va": {"banks_id": [140, 141]}}',
        signature: 'kUi2x9dKHA5VNU0FY...vySO2RLCv1htT4DqtVUkDJrOcZzUCwX6Re1kpZhkIQg=='
    }
)
  • Enforcing only one bank If you want the customer to go directly to their bank service to complete the payment (without choosing a payment method and bank on the checkout page), use the force_payment_method parameter with the indonesia-va value in the request, add the payment_methods_options object with the split_banks parameter and set the value of this parameter to true. Next, specify the ID of the required bank in the banks_id array.

    Here is an example of the payment_methods_options object from the link to open the checkout page:

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

    Here is an example of the data from a request to open the checkout page with one preselected bank by using EPayWidget.

    Figure 3. Example of the data from a request to open the checkout page with one preselected 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: 10000,
        force_payment_method: 'indonesia-va',
        payment_methods_options: '{"indonesia_va": {"banks_id": [140]}}',
        signature: 'kUi2x9dKHA5VNU0FY...vySO/RLCv1htT4DqtVUkDJrOcZzUCwX6Rek7pZhkIQg=='
    }
)

Bank IDs to be passed in the banks_id parameter

Bank IDs that you can pass in the banks_id parameter to display the icons of specific banks on the checkout page are listed in the corresponding section Banks available for purchase.

Callback

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 4. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "indonesia-va",
        "sum": {
            "amount": 10000,
            "currency": "IDR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "IDR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "1234567890"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 5. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "indonesia-va",
        "sum": {
            "amount": 10000,
            "currency": "IDR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "IDR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "1234567890"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Purchase by using Gate

General information

To perform a purchase by using Gate with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method:

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

The following figure provides the details of the purchase processing flow in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

Figure 6. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service sends the customer redirection data to the payment platform.
  6. The payment platform forwards the data to your system in the redirect_data object.
  7. Your system redirects the customer to the provider service.
  8. The customer completes the purchase.
  9. The provider service informs the payment platform about the purchase result.
  10. The payment platform sends the callback with the payment result to your system.
  11. Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/banks/indonesia-va/sale
Full API endpoint specification /v2/payment/banks/{payment_method}/sale
Table 2. Basic parameters of a purchase request

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.
ObjectParameterDescription

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required

bank_id
integer
strictly required

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase.

Example: 61021

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: IDR

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 IDR must be sent as 10000

return_url
object
optional

success
string
optional

The URL to redirect the customer to after the payment is successfully completed.

Example: https://example.com/success/

decline
string
optional

The URL to redirect the customer to after the payment is declined.

Example: https://example.com/decline/

return
string
optional

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

Example: https://example.com/return/

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method:

Figure 7. Example of the purchase request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "bank_id": 61021
    },
    "payment": {
        "currency": "IDR",
        "amount": 10000
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Customer redirection

After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting 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 send in the request body
  • method—the HTTP method for retrieving the website page (for example, POST or GET)
  • encrypted—this is the service parameter. Ignore it.

Here is an example of the callback snippet with 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

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 8. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "indonesia-va",
        "sum": {
            "amount": 10000,
            "currency": "IDR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "IDR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "1234567890"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 9. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "indonesia-va",
        "sum": {
            "amount": 10000,
            "currency": "IDR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "IDR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "1234567890"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Banks available for purchase

Supported banks

In the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method, payments are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

The table below lists the banks available for purchase in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

Table 3. Banks available for purchase
BankID
Bank Artha Graha VA57022
BANK MAYBANK INDONESIA565
Bank Sahabat Sampoerna VA4391
Bank Syariah Indonesia (BSI)69041
BCA Virtual Account55731
BNI Virtual Account2931
BRI Virtual Account499
CIMB VA436
Danamon VA435
Mandiri VA434
MAYBANK INDONESIA SYARIAH559
Maybank VA2831
Permata VA433
Sinarmas Virtual Account562

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method supports, send a request to the payment platform.

Request for the list of available banks

This section provides the instructions on how to build the request for the list of banks supported in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/info/banks/indonesia-va/sale/list
Full API endpoint specification /v2/info/banks/{payment_method}/{operationType}/list
Table 4. Parameters required in the request to get the list of banks available in the payment method

strictly required—parameter is required in the initial request.
Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

 Project ID you obtained when integrating with Monetix.

Example: 123

payment_id
string
strictly required

 Payment ID unique within the project.

If the payment is not yet created, set this parameter to a unique value.

Example: payment_47

signature
string
strictly required

 Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required

amount
integer
strictly required

 Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 IDR must be sent as 10000

currency
string
strictly required

 Code of the purchase currency in the ISO-4217 alpha-3 format.

Example: IDR
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from the request for the list of banks available in the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.

Figure 10. Example of the data from the request for the list of available banks
{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jll2ym+PtOb3ocZtr345st...=="
    },
    "payment": {
        "amount": 10000,
        "currency": "IDR"
    }
}
Figure 11. Example of the response with the list of banks available in the payment method
[
    {
        "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
            }
        ]
    }
]