Banks of Thailand - Purchase

General information

To perform a purchase by using Payment Page with the Banks of Thailand 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 Banks of Thailand payment method.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Banks of Thailand payment method.

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: 'THB',
		payment_amount: 200000,
		force_payment_method: 'online-thailand-banks',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==',
		language_code: 'id'
	}
)

Displaying bank icons on the checkout page

In the Banks of Thailand 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 Banks of Thailand payment method offers several options to display bank icons on the checkout page:

• Choosing the bank in two steps First, the customer chooses Banks of Thailand 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={"online_thailand_banks": {"split_banks": true}}
  

• Displaying only banks of the Banks of Thailand payment method For the customer to see only banks available in the Banks of Thailand payment method (without other payment methods), add the force_payment_method parameter to the request and set it to online-thailand-banks.
• Displaying only specific banks To show the customer only specific banks available in the Banks of Thailand payment method, use the force_payment_method parameter with the online-thailand-banks 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={"online_thailand_banks": {"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.

  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: 'THB',
          payment_amount: 200000,
          force_payment_method: 'online-thailand-banks',
          payment_methods_options: '{"online_thailand_banks": {"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 online-thailand-banks 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={"online_thailand_banks": {"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.

  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: 'THB',
          payment_amount: 200000,
          force_payment_method: 'online-thailand-banks',
          payment_methods_options: '{"online_thailand_banks": {"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 Banks of Thailand 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": "Thailand banks",
        "sum": {
            "amount": 200000,
            "currency": "THB"
        },
        "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": 200000,
            "currency": "THB"
        },
        "sum_converted": {
            "amount": 200000,
            "currency": "THB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123"
    },
    "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": "Thailand banks",
        "sum": {
            "amount": 200000,
            "currency": "THB"
        },
        "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": 200000,
            "currency": "THB"
        },
        "sum_converted": {
            "amount": 200000,
            "currency": "THB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test payments with the Banks of Thailand 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 Banks of Thailand 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 ID of your customer's bank you should submit 4181
• 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 Banks of Thailand 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.

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

1. Send a request for opening the checkout page to the payment platform.
2. Choose the Banks of Thailand payment method on the test checkout page. If your request contains the force_payment_method parameter with the online-thailand-banks value in it, there's no need to choose the payment method.
3. If necessary, specify any random values for the parameters you're requested to provide.
4. Choose a bank to be used for performing a test purchase.
5. Click the Success or Decline button (the respective button will be displayed depending on which amount you've submitted in your request).
6. Accept a callback containing the data about the result of performing a test payment.
7. 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 Banks of Thailand payment method by using Payment Page, see the Purchase by using Payment Page section.

Related topics

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

General information

To perform a purchase by using Gate with the Banks of Thailand 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 Banks of Thailand payment method.

Request

This section provides the instructions on how to build the request for purchase with the Banks of Thailand payment method.

Here is an example of the data from a request to initiate a purchase with the Banks of Thailand 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",
        "language": "id"
    },
    "account": {
        "bank_id": 4181
    },
    "payment": {
        "currency": "THB",
        "amount": 200000
    },
    "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": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback

In the Banks of Thailand 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": "Thailand banks",
        "sum": {
            "amount": 200000,
            "currency": "THB"
        },
        "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": 200000,
            "currency": "THB"
        },
        "sum_converted": {
            "amount": 200000,
            "currency": "THB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123"
    },
    "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": "Thailand banks",
        "sum": {
            "amount": 200000,
            "currency": "THB"
        },
        "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": 200000,
            "currency": "THB"
        },
        "sum_converted": {
            "amount": 200000,
            "currency": "THB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test payments with the Banks of Thailand 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 Banks of Thailand 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 ID of your customer's bank you should submit 4181
• 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 Banks of Thailand 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.

Testing purchase by using Gate

To perform a test purchase by using Gate:

1. Send a correct test request for purchase to the payment platform.
2. Accept a callback with redirection data.
3. Go to the received URL.
4. Click the Success or Decline button (the respective button will be displayed depending on which amount you've submitted in your request).
5. Accept a callback containing the data about the result of performing a test payment.

To learn more about performing purchases with the Banks of Thailand payment method by using Gate, see the Purchase by using Gate section.

Related topics

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

Supported banks

In the Banks of Thailand 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 Banks of Thailand payment method.

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 Banks of Thailand 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 Banks of Thailand payment method.

Here is an example of the data from the request for the list of banks available in the Banks of Thailand payment method.

{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jll2ym+PtOb3ocZtr345st...=="
    },
    "payment": {
        "amount": 200000,
        "currency": "THB"
    }
}

[
    {
        "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": "THB", // 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": "THB", // 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
            }
        ]
    }
]