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:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. 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.

Figure 1. Payout processing flow when performing a payout by using Gate
  1. The customer initiates a payout in your system.
  2. Your system sends the payout 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 informs the payment platform about the payout result.
  6. The payment platform sends a callback with the payout result to your system.
  7. 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
Table 1. Basic parameters of a payout request

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

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

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required

number
string
strictly required

Customer's account number.

Example: 123456

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

Example: 61021

customer_name
string
strictly required

Customer's full name.

Example: John Doe

payment
object
strictly required

currency
string
strictly required

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

Example: THB

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: 2000.00 THB must be sent as 200000

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:

Figure 2. Example of the payout 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",
        "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.

Figure 3. Example of the data from a successful payout callback
{
    "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.

Figure 4. Example of the data from a declined payout callback
{
    "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:

  1. Send a correct test request for payout to the payment platform.
  2. 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

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through 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.

Table 2. Banks available for payout
BankID
ANZ Bank (Thai) PCL6561
Bangkok Bank124
Bank For Agriculture And Agricultural Cooperatives5851
Bank of America N.A.6481
Bank Of Ayudhya127
Bank of China (Thai) Public Company6531
Bank of Thailand74702
BNP Paribas, Bangkok6521
CIMB Thailand483
Citibank5921
Deutsche Bank60081
Government Housing Bank4701
Government Savings Bank128
HSBC bank3001
Indian Overseas Bank68921
Industrial and Commercial Bank of China (Thai)3911
Islamic Bank of Thailand5841
JPMorgan Chase Bank, Bangkok Branch6421
KasiKorn Bank123
Kiatnakin Bank (KNK)710
Krung Thai Bank126
Land and Houses Bank5911
Mega International Commercial Bank6471
Mizuho Bank Bangkok Branch60071
Mizuho Corporate Bank5891
Siam Commercial Bank125
Standard Chartered Bank4711
Sumitomo Mitsui Banking Corporation5901
Sumitomo Mitsui Trust Bank (Thai) Public Company Limited22601
Thai Credit Retail Bank5941
Tisco Bank66661
TMB Bank Public Company Limited129
UOBT395

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
Table 3. 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: 2000.00 THB must be sent as 200000

currency
string
strictly required

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

Example: THB

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.

Figure 5. 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": 200000,
        "currency": "THB"
    }
}
Figure 6. 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": "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
            }
        ]
    }
]