Krung Thai (KTB NEXT)

Enable your customers to pay using their KTB NEXT application on their mobile phones. Eliminating the need to enter their card details can help customers to check out faster.

This guide walks you through the payment flow and details how to implement it.

The customer is required to have a mobile application KTB NEXT.

How to enable

• Supported Countries: Thailand
• Minimum API version: 2017-11-02

To enable Krung Thai (KTB NEXT), send an email requesting this feature to support@omise.co. You will need to review and accept new terms and conditions.

Payment flow

Customers paying via Mobile Banking go through an off-site payment flow. This means that once the charge is created, it can only be authorized via the corresponding Bank’s application. The customer must authorize the payment using that banking app on their phone to complete the flow.

After the customer selects Mobile Banking as their preferred payment method, your site should redirect to the bank’s application using the resulting URI (a “deep link” that will automatically open the installed handler app). The following screenshots demonstrate completing payment flow using mobile banking. The customer must pay via the bank's app to complete the payment.

Using a mobile

❶ The customer chooses to pay with Mobile banking. ❷ and chooses the bank they want to pay with. ❸ The payment details are shown, and they then confirm the payment. ❹ The customer can be redirected to the merchant's confirmation page. ❺ After completing the payment, the customer will be automatically redirected to the merchant's payment confirmation page.

Using a desktop browser

❶ The customer chooses the bank they want to pay with. ❷ After that, the QR code will be shown. ❸ Customer opens the corresponding app and then uses the QR scanner. ❹ Customer scans the QR on the payment page with their phone. ❺ The payment details are shown, and they then confirm the payment. ❻ The customer can be redirected to the merchant's confirmation page, or in the last step, the customer will be automatically redirected to the merchant's payment confirmation page.

Implementation

Make the following API requests to create a charge using Krung Thai (KTB NEXT).

1. Create a new payment source (type: mobile_banking_ktb) using Omise.js or one of the mobile SDKs (iOS and Android)
2. Create a new charge using the identifier of the source created in Step 1.
3. After receiving the charge completion webhook event, retrieve the charge to verify its status (optional, but recommended).

Use your public key to create the Krung Thai (KTB NEXT) source on the client (a customer's browser or mobile phone). Use your secret key to generate the server's Krung Thai (KTB NEXT) charge.

If both the creation and charge of a source must happen server-side, you can create and charge the source in a single API request using your secret key.

Creating a source

When the customer confirms that they wish to pay with this payment method, create a new source specifying the amount, currency, platform_type, and type.

The following examples demonstrate the creation of a new Krung Thai (KTB NEXT) source for ฿20. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with the test public key on your dashboard.

Using Omise.js, the type parameter is supplied as the first argument to the createSource method.

Omise.setPublicKey(omise_public_key);

Omise.createSource('mobile_banking_ktb', {
  "amount": 2000,
  "currency": "THB"
}, function(statusCode, response) {
  console.log(response)
});

For testing, you can create the same request using curl.

curl https://api.omise.co/sources \
  -u $OMISE_PUBLIC_KEY: \
  -d "amount=2000" \
  -d "currency=THB" \
  -d "type=mobile_banking_ktb"

{
  "object": "source",
  "id": "src_test_5xoynunmw3lr5k0zkb2",
  "livemode": false,
  "location": "/sources/src_test_5xoynunmw3lr5k0zkb2",
  "amount": 2000,
  "barcode": null,
  "bank": null,
  "created_at": "2023-11-07T10:48:28Z",
  "currency": "THB",
  "email": null,
  "flow": "app_redirect",
  "installment_term": null,
  "ip": null,
  "absorption_type": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "billing": null,
  "shipping": null,
  "items": [],
  "references": null,
  "provider_references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "mobile_banking_ktb",
  "zero_interest_installments": null,
  "charge_status": "unknown",
  "receipt_amount": null,
  "discounts": []
}

The id attribute is the source identifier (begins with src).

Creating a charge

Create a charge specifying the parameters return_uri, source, amount, and currency.

• return_uri specifies the location on your website to which the customer should be redirected after completing the payment authorization step.
• source specifies the source identifier.
• The amount and currency must match those of the source.

By default, the charge expires 30 minutes after creation.

The following example demonstrates how to create a charge using curl. Replace $OMISE_SECRET_KEY with the test secret key on your dashboard. Replace $SOURCE_ID with the id of the source.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=2000" \
  -d "currency=THB" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"

{
  "object": "charge",
  "id": "chrg_test_5xoynuqetk6yh1q1320",
  "location": "/charges/chrg_test_5xoynuqetk6yh1q1320",
  "amount": 2000,
  "net": 930,
  "fee": 1000,
  "fee_vat": 70,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 2000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": "10.0",
    "fee_rate": "0.0",
    "vat_rate": "7.0"
  },
  "platform_fee": {
    "fixed": null,
    "amount": null,
    "percentage": null
  },
  "currency": "THB",
  "funding_currency": "THB",
  "ip": null,
  "refunds": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/charges/chrg_test_5xoynuqetk6yh1q1320/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2023-11-07T10:48:29Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_5xoynuf25kag18sqcig",
    "livemode": false,
    "location": "/sources/src_test_5xoynuf25kag18sqcig",
    "amount": 2000,
    "barcode": null,
    "bank": null,
    "created_at": "2023-11-07T10:48:27Z",
    "currency": "THB",
    "email": null,
    "flow": "app_redirect",
    "installment_term": null,
    "ip": null,
    "absorption_type": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": "IOS",
    "scannable_code": null,
    "billing": null,
    "shipping": null,
    "items": [],
    "references": null,
    "provider_references": {
      "reference_number_1": "4Kg4utBGTBiJbJ3p",
      "reference_number_2": null
    },
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "mobile_banking_ktb",
    "zero_interest_installments": null,
    "charge_status": "pending",
    "receipt_amount": null,
    "discounts": []
  },
  "schedule": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/payments/pay2_test_5xoynuqgg5a53ee5bai/authorize",
  "return_uri": "https://example.com/orders/345678/complete",
  "created_at": "2023-11-07T10:48:28Z",
  "paid_at": null,
  "expires_at": "2023-11-14T10:48:28Z",
  "expired_at": null,
  "reversed_at": null,
  "zero_interest_installments": false,
  "branch": null,
  "terminal": null,
  "device": null,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": false,
  "refundable": false,
  "partially_refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false
}

Creating a source and charge

Alternatively, you can create and charge a source in a single API request.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=2000" \
  -d "currency=THB" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source[type]=mobile_banking_ktb"

Setting the charge to expire

By default, the charge expires 30 mins after creation.

You can assign different expiration periods to each charge by entering a timestamp between 60 seconds and 30 mins from the current time in the expires_at field of the Charge API. If the timestamp is entered correctly, the charge will expire at the designated time instead of the default period.

After creating the charge, you can manually call our Expire API to expire a pending charge.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=2000" \
  -d "currency=THB" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source[type]=mobile_banking_ktb" \
  -d "expires_at=2023-11-07T18:00:00Z"

Completing the charge

You have created a charge with its status set to pending. Other possible values for charge status are successful, failed, and expired.

The following sections detail how to authorize a charge, receive its completion webhook event, and update its status.

Authorizing the charge

Redirect the customer to the location specified in authorize_uri so they can authorize the charge.

The merchant can simulate this authorization phase in test mode by visiting authorize_uri and manually marking the charge as Successful or Failed.

After the customer has completed the authorization phase, they will be redirected to the location specified in return_uri.

Receiving the charge completion event

The best way to be notified about the completion of a charge is by using webhook events.

Set up a location on the merchant server to receive webhook events and add this location as a webhook endpoint on the dashboard.

Checking the charge status

After receiving this event, retrieve the charge using its id and confirm that its status matches the status of the charge contained in the event.

If the value of status is successful, you got paid.

If the value of status is failed, check the failure_code and failure_message in the charge object for an explanation.

Possible failure codes are as follows.

Mobile Banking charges cannot be voided or refunded through Omise.

Limits

• Minimum: 2000 (THB20.00)
• Maximum: 15000000 (THB150,000.00)

Related API documentation

• Charge
• Source
• Webhook

How to check the public key and secret key

For information on obtaining and checking the public and secret keys, please refer to this document.