Scenario 2. Purchase with payment instructions
When performing a purchase, the customer follows the payment instructions displayed on the checkout page or in your system (when performing the purchase by using Gate).
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
|
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:
- Send a request with all the required parameters and signature to the Monetix URL.
- 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.
- The customer initiates a purchase in your system.
- Your system sends the request for the purchase through Payment Page to the Monetix URL.
- The checkout page is displayed to the customer.
- The customer chooses to make a purchase with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.
- The payment platform forwards the request to the provider service.
- The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
- The checkout page displays the payment instructions to the customer.
- The customer completes the purchase.
- The provider service sends the purchase result information to the payment platform.
- The payment platform sends a callback with the payment result to your system.
- 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.
|
||
---|---|---|
Parameter | Description | |
project_id | Project ID you obtained from Monetix when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | |
customer_id | Unique ID of the customer within your project. Example: | |
customer_first_name | Customer's first name. Example: | |
customer_last_name | Customer's last name. Example: | |
customer_email | Customer's email. Example: | |
payment_currency | Code of the payment currency in the ISO-4217 alpha-3 format.
Example: | |
payment_amount | 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 | |
force_payment_method | 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 Example: | |
signature | 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 totrue
. 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 totrue
. 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.
{
"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.
{
"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=="
}
Testing
You can test payments with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method by using Payment Page.
To start performing test payments, reach out to the Monetix (support@monetix.pro) support team to get the test project ID and a secret key to it and then contact your key account manager at Monetix to set up the test environment for the payments to be performed with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.
When performing test payments, keep in mind that:
- for the project ID you have to submit the ID of the test project
- for the payment ID and customer's data you can submit any random values
- for the currency of the payment you should submit IDR
- the interface of the test checkout page may be different from the one Monetix provides you with.
Statuses of test payments
To receive a certain final status when performing test payments with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method, your request has to contain a respective payment amount in it. The table below lists the payment amounts you can send in requests in order to get a certain status of a test payment.
Payment amount | Final status |
---|---|
40000 or 40400 | decline—the payment is declined |
Any other amount | success—the payment is successful. The payment amount passed to you in a callback matches the amount you submitted in the purchase request |
Testing purchase by using Payment Page
To perform a test purchase by using Payment Page:
- Send a request for opening the checkout page to the payment platform.
- Choose the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method on the test checkout page. If your request contains the force_payment_method parameter with the
indonesia-va
value in it, there's no need to choose the payment method. - If necessary, specify any random values for the parameters you're requested to provide.
- Wait for the payment instructions to be displayed to you.
- Accept a callback containing the data about the result of performing a test payment.
- Wait for a few seconds until the test checkout page displays the result of performing a test payment.
To learn more about performing purchases with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method by using Payment Page, see the Purchase by using Payment Page section.
Purchase by using Gate
General information
To perform a purchase by using Gate with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Show the screen with payment instructions to the customer.
- 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.
- The customer initiates a purchase in your system.
- Your system sends the purchase request to the Monetix payment platform.
- 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.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
- The payment platform forwards the instructions to your system in the display_data array.
- Your system displays the payment instructions to the customer.
- The customer completes the purchase.
- The provider service informs the payment platform about the purchase result.
- The payment platform sends the callback with the payment result to your system.
- 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 |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general | project_id | Project ID you obtained from Monetix when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | ||
signature | Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
customer | id | Unique ID of the customer within your project. Example: | |
ip_address | IP address of the customer's device. Example: | ||
first_name | Customer's first name. Example: | ||
last_name | Customer's last name. Example: | ||
email | Customer's email. Example: | ||
account | bank_id | Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase. Example: | |
payment | currency | Code of the payment currency in the ISO-4217 alpha-3 format. Example: | |
amount | 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 | ||
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:
{ "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 } }
Displaying the payment instructions to the customer
After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.
Use the data from the display_data array to display the payment instructions to the customer.
Element | Description |
---|---|
{ "type": "add_info", "title": "invoice_number", "data": "12345678987654" } |
Payment number. Example: |
{ "type": "add_info", "title": "virtual_account_number", "data": "8889940000012345" } |
Virtual account number of payment recipient. Example: |
{ "type": "add_info", "title": "request_amount", "data": "200000" } |
Payment amount. Example: |
{ "type": "add_info", "title": "request_currency", "data": "IDR" } |
Payment currency code. Example: |
{ "type": "add_info", "title": "expired_date", "data": "1648190569" } |
Payment expiration deadline. Specified in Unix time. Example: |
The following is the callback fragment containing display_data array.
"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
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.
{
"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.
{
"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=="
}
Testing
You can test payments with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method by using Gate.
To start performing test payments, reach out to the Monetix (support@monetix.pro) support team to get the test project ID and a secret key to it and then contact your key account manager at Monetix to set up the test environment for the payments to be performed with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method.
When performing test payments, keep in mind that:
- for the project ID you have to submit the ID of the test project
- for the currency of the payment you should submit IDR
- for the payment ID and customer's data you can submit any random values
Statuses of test payments
To receive a certain final status when performing test payments with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method, your request has to contain a respective payment amount in it. The table below lists the payment amounts you can send in requests in order to get a certain status of a test payment.
Payment amount | Final status |
---|---|
40000 or 40400 | decline—the payment is declined |
Any other amount | success—the payment is successful. The payment amount passed to you in a callback matches the amount you submitted in the purchase request |
Testing purchase by using Gate
To perform a test purchase by using Gate:
- Send a correct test request for purchase to the payment platform.
- Accept a callback with the data for displaying payment instructions. Your system will display the payment instructions to you after.
- Accept a callback containing the data about the result of performing a test payment.
To learn more about performing purchases with the ATM & Bank Transfer in Indonesia (Virtual Accounts) payment method by using Gate, see the Purchase by using Gate section.
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.
Bank | ID |
---|---|
Bank Sahabat Sampoerna VA | 4391 |
BCA Virtual Account | 55731 |
BNI Virtual Account | 2931 |
BRI Virtual Account | 499 |
BSMVA | 55821 |
CIMB Niaga | 2201 |
CIMB VA | 436 |
Danamon VA | 435 |
DOKUVA | 55831 |
Mandiri VA | 434 |
Permata VA | 433 |
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 |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general |
project_id |
Project ID you obtained when integrating with Monetix.
Example: |
|
payment_id |
Payment ID unique within the project.
If the payment is not yet created, set this parameter to a unique value. Example: |
||
signature |
Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification. | ||
payment |
amount |
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 |
|
currency |
Code of the purchase currency in the ISO-4217 alpha-3 format.
Example: |
||
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.
{ "general": { "project_id": 200, "payment_id": "ORDER_155860015", "signature": "K6jll2ym+PtOb3ocZtr345st...==" }, "payment": { "amount": 10000, "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 } ] } ]