Payout
When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.
Countries and regions | Thailand |
Payment currencies | THB |
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. |
Operations support
Interfaces | |||
---|---|---|---|
Payment Page | Gate | Dashboard | |
Payout |
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.
Payout by using Gate
General information
To perform a payout by using Gate with the Banks of Thailand payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Accept the callback with the payout result from the payment platform.
The following picture provides the details of the payout processing flow in the Banks of Thailand payment method.
- The customer initiates a payout in your system.
- Your system sends the payout 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 informs the payment platform about the payout result.
- The payment platform sends a callback with the payout result to your system.
- Your system sends the payout result to the customer.
Request
This section provides the instructions on how to build the request for payout with the Banks of Thailand payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/banks/thailand/payout |
Full API endpoint specification | /v2/payment/banks/{payment_method}/payout |
|
|||
---|---|---|---|
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: | ||
email | Customer's email. Example: | ||
account | number | Customer's account number. Example: | |
bank_id | Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for payout. Example: | ||
customer_name | Customer's full name. 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: 2000.00 THB must be sent as | ||
You can also add any other optional parameters to the payout 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 payout 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", "email": "johndoe@example.com" }, "account": { "number": "123456", "bank_id": 61021, "customer_name": "John Doe" }, "payment": { "currency": "THB", "amount": 200000 } }
Callback
In the Banks of Thailand payment method, the payment platform returns the payout 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 payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"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": "payout",
"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": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
The following is an example of a callback for a declined payout.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "payout",
"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": "payout",
"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": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
Testing
You can test payouts with the Banks of Thailand payment method by using Gate.
To start performing test payouts, 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 payouts to be performed with the Banks of Thailand payment method.
When performing test payouts, 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 payouts
To receive a certain final status when performing test payouts with the Banks of Thailand payment method, your request has to contain a respective payment amount in it. The table below lists the payout amounts you can send in requests in order to get a certain status of a test payout.
Payout amount | Final status |
---|---|
40000 or 40400 | decline—the payout is declined |
Any other amount | success—the payout is successful |
Testing payout by using Gate
To perform a test payout by using Gate:
- Send a correct test request for payout to the payment platform.
- Accept a callback containing the data about the result of performing a test payout.
To learn more about performing payouts with the Banks of Thailand payment method by using Gate, see the Payout by using Gate section.
Payout by using Dashboard
- single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
- as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.
Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.
For more information about payout processing by using Dashboard, see Performing payouts.
Banks available for payout
Supported banks
In the Banks of Thailand payment method, payments are performed through the banks the payment method supports. For the payout 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 payout in the Banks of Thailand payment method.
Bank | ID |
---|---|
ANZ Bank (Thai) PCL | 6561 |
Bangkok Bank | 124 |
Bank For Agriculture And Agricultural Cooperatives | 5851 |
Bank of America N.A. | 6481 |
Bank Of Ayudhya | 127 |
Bank of China (Thai) Public Company | 6531 |
Bank of Thailand | 74702 |
BNP Paribas, Bangkok | 6521 |
CIMB Thailand | 483 |
Citibank | 5921 |
Deutsche Bank | 60081 |
Government Housing Bank | 4701 |
Government Savings Bank | 128 |
HSBC bank | 3001 |
Indian Overseas Bank | 68921 |
Industrial and Commercial Bank of China (Thai) | 3911 |
Islamic Bank of Thailand | 5841 |
JPMorgan Chase Bank, Bangkok Branch | 6421 |
KasiKorn Bank | 123 |
Kiatnakin Bank (KNK) | 710 |
Krung Thai Bank | 126 |
Land and Houses Bank | 5911 |
Mega International Commercial Bank | 6471 |
Mizuho Bank Bangkok Branch | 60071 |
Mizuho Corporate Bank | 5891 |
Siam Commercial Bank | 125 |
Standard Chartered Bank | 4711 |
Sumitomo Mitsui Banking Corporation | 5901 |
Sumitomo Mitsui Trust Bank (Thai) Public Company Limited | 22601 |
Thai Credit Retail Bank | 5941 |
Tisco Bank | 66661 |
TMB Bank Public Company Limited | 129 |
UOBT | 395 |
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
The list of banks may change that's why we recommend that you send the payment platform a request for the list of banks currently available in the Banks of Thailand payment method. The request format and structure should be the following:
HTTP request method | POST |
Request body format | JSON |
API endpoint |
/v2/info/banks/thailand/payout/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: 2000.00 THB must be sent
as |
|
currency |
Code of the payout 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 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 } ] } ]