Thai Online Banking

Overview

Introduction

Thai Online Banking is a payment method which allows to process payments in Thai bahts by using bank accounts in Thailand. This method supports payouts.

This article provides information about working with the Thai Online Banking method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type Bank payments
Payment instruments Bank accounts
Countries and regions TH
Payment currencies THB
Currency conversion
One-time purchases
Credential-on-file purchases
Full refunds
Partial refunds
Payouts +
Notes
Onboarding and access fee refer to your Eposservice key account manager

Interaction diagram

Payment processing by using the Thai Online Banking method involves the merchant's web service, one of Eposservice interfaces, the Eposservice payment platform, and technical facilities of the bank service.

Operations support

Various platform interfaces can be used to process payments and perform operations using the Thai Online Banking method. Payouts can be processed by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the Thai Online Banking the following properties and limitations are applicable.

Amounts, THB Times ²
minimum maximum base threshold
Payouts 500.00 500,000.00 * *
Note:
  1. Keep in mind that payment processing times depend on banks, that support purchases by using this payment method.
  2. The base and threshold times are defined as follows:
    • The base time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the web service. The base time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact Eposservice technical support.

Processing scenarios

To initiate a payout, you need to notify the customer via the web service.

General scenario of processing payouts can be presented as follows.

Figure 4. Payout by using Gate


Supported banks

The following table lists the names and identifiers of banks supported by the Thai Online Banking method. Keep in mind that this list is presented for informational purposes.

Figure 5. List of banks
Bank ID
Bangkok Bank 124
Bank Of Ayudhya 127
Government Housing Bank 4701
Government Savings Bank 128
KasiKorn Bank 123
Krung Thai Bank 126
Land and Houses Bank 5911
Siam Commercial Bank 125
Standard Chartered Bank 4711
Thanachart Bank 745
TMB Bank Public Company Limited 129
UOBT 395

Since the list of available banks may change over time, it is recommended to send a POST request to the /v2/info/banks/thailand/payout/list endpoint to obtain up-to-date information. These endpoints belong to the /v2/info/banks/{payment_method}/{operationType}/list group of the Gate API. The request must contain the project and payment identifiers, signature, currency code, and payment amount, as shown in the example. Specify real payment data if possible. However, random values are also allowed.

Figure 6. Example of data in the request for receiving the list of banks
{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "THB"
  }
}
Figure 7. Example of data in the response containing the information about banks
[
  {
    "id": 124, // Bank ID
    "abbr": "BBL", // Bank abbreviation (for internal use)
    "name": "BBL", // International bank name
    "nativeName": "Bangkok Bank", // Local bank name
    "currencies": [ // Array with information about the currencies supported by the bank
      {
        "id": 981, // Currency ID in the payment platform
        "alpha_3_4217": "THB", // ISO-4217 alphabetic currency code
        "number_3_4217": "764", // ISO-4217 numeric currency code
        "exponent": 2 // The number of decimal units of the currency
      }
    ]
  },  
  {
    "id": 4701, 
    "abbr": "GHB", 
    "name": "Government Housing Bank", 
    "nativeName": "Government Housing Bank", 
    "currencies": [
      {
        "id": 981,
        "alpha_3_4217": "THB",
        "number_3_4217": "764",
        "exponent": 2
      }
    ]
  },
  {
    "id": 745, 
    "abbr": "TBANK", 
    "name": "TMB Thanachart Bank", 
    "nativeName": "TMB Thanachart Bank",
    "currencies": [
      {
        "id": 981,
        "alpha_3_4217": "THB",
        "number_3_4217": "764",
        "exponent": 2
      }
    ]
  }
]
]

If you have any questions about working with banks supported by the Thai Online Banking method, refer to your Eposservice account manager.

Payouts by using Gate

General information

To process a payout through Gate by using the Thai Online Banking method, send a request with all required parameters and signature to the Eposservice URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.



Figure 8. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the Thai Online Banking method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified Eposservice URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the bank service.
  7. The payout is processed on the side of the bank service.
  8. The bank service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the Thai Online Banking method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the Thai Online Banking method:

  1. To initiate each payout send a separate POST request to the /v2/payment/banks/thailand/payout endpoint, which belongs to the group /v2/payment/banks/{payment_method}/payout.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from Eposservice during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payout
    • Object account—customer account information:
      • number—customer account number
      • customer_name—name of bank account holder
      • bank_id—bank identifier
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Thai Online Banking method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer and account information, as well as signature.

{
    "general": {
        "project_id": 2990,
        "payment_id": payment_id,
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNNSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 10000,
      "currency": "THB"
      },
    "customer": {
      "id":"2990",
      "ip_address": "248.121.176"
    },
  "account":{
      "bank_id": 124,      
      "customer_name": "Putra account",
      "number": "314159265358979"
    }
}
Figure 9. Example of sufficient data in a purchase request
{
    "general": {
        "project_id": 2990,
        "payment_id": payment_id,
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNNSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 10000,
      "currency": "THB"
      },
    "customer": {
      "id":"2990",
      "ip_address": "248.121.176"
    },
  "account":{
      "bank_id": 124,      
      "customer_name": "Putra account",
      "number": "314159265358979"
    }
}

Callback format

The Thai Online Banking method uses the standard format for callbacks to deliver payout results. For more information, see Handling callbacks.

The following is the example of a callback with information about a 2,000.00 THB payout made in the 200 project.

Figure 10. Example of callback data indicating that the payout has been processed
 {
        "project_id": 200,
        "payment": {
            "id": "PAYOUT7891022555",
            "type": "payout",
            "status": "success",
            "date": "2022-09-12T13:28:58+0000",
            "method": "Thailand banks",
            "sum": {
                "amount": 200000,
                "currency": "THB"
            },
            "description": ""
        },
        "account": {
            "number": "6419422222",
            "bank_id":124
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 15112000002236,
            "type": "payout",
            "status": "success",
            "date": "2022-09-12T13:28:58+0000",
            "created_date": "2022-09-12T13:22:15+0000",
            "request_id": "b54610e94a76",
            "sum_initial": {
                "amount": 20000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 200000,
                "currency": "THB"
            },
            "provider": {
                "id": 1152,
                "payment_id": "E80NPPQ6Z1YSYPZTPH0NBON42",
                "date": "2022-09-12T13:28:34+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "qV2FRs/wxoOaywQS0GYQDi+6spW80mynkaQfSAUJpfQ=="
    }

The following is the example of a callback with information about a declined payout.

Figure 11. Example of callback data indicating that the payout has been declined
{
        "project_id": 200,
        "payment": {
            "id": "PAYOUT789",
            "type": "payout",
            "status": "decline",
            "date": "2022-09-07T09:44:43+0000",
            "method": "Thailand banks",
            "sum": {
                "amount": 60000000,
                "currency": "THB"
            },
            "description": ""
        },
        "account": {
            "number": "6419422222",
            "bank_id":140
        },
        "customer": {
            "id": "1"
        },
        "errors": [
            {
                "code": "3104",
                "message": "Payment Constraint Invalid Payout Amount",
                "description": "Gate. Operation was declined. Maximum payout limit is exceeded"
            }
        ],
        "operation": {
            "id": 533000002202,
            "type": "payout",
            "status": "decline",
            "date": "2022-09-07T09:44:43+0000",
            "created_date": "2022-09-07T09:44:43+0000",
            "request_id": "205d3536a91f4737d6fa7d248258224fe3f6",
            "sum_initial": {
                "amount": 60000000,
                "currency": "THB"
            },
            "sum_converted": {
                "amount": 60000000,
                "currency": "THB"
            },
            "provider": {
                "id": 1152,
                "payment_id": ""
            },
            "code": "3104",
            "message": "Payment Constraint Invalid Payout Amount"
        },
        "signature": "j4cxKDvx0EHot6v83rzDMlinxE915lAWGHKVjurpQ=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the Thai Online Banking method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.
  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Testing

General information

For the Thai Online Banking method, it is possible to test payouts by using Gate. To enable and disable testing, as well getting assistance with setting up a test project, refer to Eposservice technical support.

When testing payments keep in mind that the test project identifier must be indicated in requests.

Test payments statuses

The final status of test payments and operations is determined by the amount specified in the request.

Test payouts:

  • 40000 or 40400 amount to get the decline status
  • any other amount to get the success status

Payouts by using Gate

To process a test payout by using Gate, send a valid test request for a payout to the payment platform and receive a final callback with information about the payout result. More information about processing payouts by using the Thai Online Banking method via Gate is provided in the Payouts by using Gate section.

Analysis of payments results

To analyse information about payments made with the Thai Online Banking method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and Eposservice technical support.