Bangkok Bank (Bualuang mBanking)

Enable your customers to make payments using their Bualuang mBanking 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 Bualuang mBanking.

How to enable

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

To enable Bangkok Bank (Bualuang mBanking), 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 the payment flow using a mobile browser. The customer must pay via the bank's app to complete the payment.

Using a mobile browser

❶ The customer chooses to pay with mobile banking. ❷ The customer 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 details page. ❺ Customer is redirected to merchant's confirmation details page.

Implementation

Make the following API requests to create a charge using Bangkok Bank (Bualuang mBanking).

1. Create a new payment source (type: mobile_banking_bbl) 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 Bangkok Bank (Bualuang mBanking) source on the client (a customer's browser or mobile phone). Use your secret key to create the Bangkok Bank (Bualuang mBanking) charge on the server.

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 creating a new Bangkok Bank (Bualuang mBanking) source for ฿1500. 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_bbl', {
  "amount": 150000,
  "currency": "THB",
  "platform_type": "IOS"
}, 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=150000" \
  -d "currency=THB" \
  -d "type=mobile_banking_bbl" \
  -d "platform_type=IOS"

{
  "object": "source",
  "id": "src_5wynl3akvgx8z8y05ai",
  "livemode": true,
  "location": "/sources/src_5wynl3akvgx8z8y05ai",
  "amount": 150000,
  "barcode": null,
  "bank": null,
  "created_at": "2023-09-01T04:33:34Z",
  "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": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "mobile_banking_bbl",
  "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 15 minutes after creation.

The following example demonstrates how to create a new 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=150000" \
  -d "currency=THB" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"

{
  "object": "charge",
  "id": "chrg_5wynl3dc8lzeknseles",
  "location": "/charges/chrg_5wynl3dc8lzeknseles",
  "amount": 150000,
  "net": 148930,
  "fee": 1000,
  "fee_vat": 70,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 150000,
  "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_5wynl3dc8lzeknseles/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2023-09-01T04:33:36Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_5wynl2qorm20pys4p6i",
    "livemode": true,
    "location": "/sources/src_5wynl2qorm20pys4p6i",
    "amount": 150000,
    "barcode": null,
    "bank": null,
    "created_at": "2023-09-01T04:33:31Z",
    "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": "5WYNL3DDV9GM32LZGN5",
      "reference_number_2": null
    },
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "mobile_banking_bbl",
    "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": "bualuangmbanking://mbanking.payment?paymentIdentifier=5WYNL3DDV9GM32LZGN5&paymentRequestId=4A2F850C-49BD-4FEA-9BEA-926C3C4A6211&signature=mqmXLkKsV3dYs5odL0tpgnUJca%2BKifmZbu%2F%2BbG%2BQV4T8cONMZAIb0u%2Fg0P0NN0puRVqUb6kAKxnO6b7U%2BG3%2FTQ6aYmK%2F0VfJz6cDNtbMsSSl3%2FETXIZPsRhauRNfpkbJBTVwkaFBhGhq1TbRxO6vEcXo8GFQ%2FQWLim24km2i3SjZAJJTT04CK9irnWyf7OERl4pdG4Sm8yaRm1v4w9hmhZB17D62DrmleOFjem1gyDRCXCQuHajgpoQH46fijX6dTx8IIwg6vUr8c0BrSNeFnlMCPmX11Dh8PWRI9%2FkgS60I9IEs0AAqcCWkNDT0ONxcFcbPLjIBZw61qAomWA4oQA%3D%3D&siteName=OMISEAPP&timeStamp=2023-09-01T11%3A33%3A35.827%2B07%3A00",
  "return_uri": "https://example.com/orders/345678/complete",
  "created_at": "2023-09-01T04:33:34Z",
  "paid_at": null,
  "expires_at": "2023-09-01T04:48:35Z",
  "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": true,
  "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=150000" \
  -d "currency=THB" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source[type]=mobile_banking_bbl" \
  -d "source[platform_type]=IOS"

Completing the charge

You have created a new 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.

This sequence diagram shows the entire flow.

Authorizing the charge

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

You can simulate this authorization phase in test mode by visiting the authorize_uri to manually mark the charge as Successful or Failed. After the customer has completed the authorization phase, they will be redirected to the location you specified in return_uri.

Receiving the charge completion event

The best way to be notified of a charge completion is by using webhook events. Set up a location on your server to receive webhook events, and add this location as a webhook endpoint on the dashboard.

Once a charge is completed, a POST request with the charge response embedded will be sent to this endpoint.

The key attribute for the event object contains charge.complete, and the data attribute contains the charge object. See Events API for the event object structure.

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 listed below.

Mobile Banking charges cannot be voided or refunded through Omise.

Limits

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

Next steps

• Charge API
• Source API
• Webhooks API