อยู่ระหว่างการจัดทำบทความภาษาไทย

Mobile Banking BETA

หัวข้อทั้งหมดในหน้านี้

Create a seamless mobile shopping experience, both through mobile browser and application, for customers by adding Mobile Banking as a payment option.

This payment method has a number of convenient features, such as the fact that the user will not provide a card number, the charge details are confirmed by a familiar authority (the bank) through a familiar channel (the app), before being applied, and it does not use third party networks (the circuit is shorter, thus operations will normally flow faster).

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

How to enable

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

To enable Mobile Banking, send an email requesting this feature to support@omise.co. You will need to review and accept new terms and conditions.

Supported banks

Bank Service Source type
SCB SCB Easy Net mobile_banking_scb

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 by using the resulting URI (a “deep link” that will automatically open the installed handler app). The following screenshots demonstrate two flows: one using a desktop browser and one using a mobile browser. In both cases, the customer must pay via the bank's app to complete the payment.

Using a desktop browser

Mobile Banking Desktop

The customer chooses the bank they want to pay with ❶ ,after that a QR code will be shown ❷. The customer opens their phone's QR code scanner ❸. The customer scans the QR code ❹. The customer is redirected to the appropriate bank's app to complete their payment ❺. The payment confirmation slip is shown. The customer can choose to be redirected to the merchant's payment confirmation page ❻. Once you receive a webhook completion event, confirm the payment with the customer ❺.

Using a mobile browser

Mobile Banking Mobile

The customer chooses the bank they want to pay with ❶ they then confirm the payment using their mobile phone ❷. The payment details are shown ❸. The customer can choose to be redirected to the merchant's confirmation details page by pressing on Back to merchant ❹.

Implementation

To create a charge using Mobile Banking, make the following API requests.

  1. Create a new payment source (type: mobile_banking_scb) 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 Mobile Banking source on the client (a customer's browser or mobile phone). Use your secret key to create the Mobile Banking 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, and type.

The following examples demonstrate the creation of a new Mobile Banking source for ฿4,000. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with the test public key found 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_scb', {
  "amount": 400000,
  "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=400000" \
  -d "currency=THB" \
  -d "type=mobile_banking_scb"
{
  "object": "source",
  "id": "src_test_5ovr9qjyoislo1dj8iv",
  "livemode": false,
  "location": "/sources/src_test_5ovr9qjyoislo1dj8iv",
  "amount": 400000,
  "barcode": null,
  "bank": null,
  "created_at": "2021-08-18T10:58:51Z",
  "currency": "THB",
  "email": null,
  "flow": "app_redirect",
  "installment_term": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "mobile_banking_scb",
  "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.
  • amount and currency must match amount and currency of the source.

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

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=400000" \
  -d "currency=THB" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"
{
  "object": "charge",
  "id": "chrg_test_5ovr9qmysh12anz2n4s",
  "location": "/charges/chrg_test_5ovr9qmysh12anz2n4s",
  "amount": 400000,
  "net": 399144,
  "fee": 800,
  "fee_vat": 56,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 400000,
  "refunded_amount": 0,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": false,
  "refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false,
  "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_5ovr9qmysh12anz2n4s/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2021-08-18T10:58:52Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_5ovr9q9lvicnzjcy1gf",
    "livemode": false,
    "location": "/sources/src_test_5ovr9q9lvicnzjcy1gf",
    "amount": 400000,
    "barcode": null,
    "bank": null,
    "created_at": "2021-08-18T10:58:50Z",
    "currency": "THB",
    "email": null,
    "flow": "app_redirect",
    "installment_term": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": null,
    "scannable_code": null,
    "references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "mobile_banking_scb",
    "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": "scbeasy://partner/consent/application/l76b66f720c4514644a427d612f50a5062/transaction/208ca189-ae6c-49bb-b600-a9aee510d799",
  "return_uri": "https://example.com/orders/345678/complete",
  "created_at": "2021-08-18T10:58:52Z",
  "paid_at": null,
  "expires_at": "2021-08-25T10:58:52Z",
  "expired_at": null,
  "reversed_at": null,
  "zero_interest_installments": true,
  "branch": null,
  "terminal": null,
  "device": null
}

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=400000" \
  -d "currency=THB" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source[type]=mobile_banking_scb"

Completing the charge

At this point, 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.

sequenceDiagram participant customer participant omise.js participant merchant participant api.omise.co customer->>omise.js: Send payment details for purchase omise.js->>api.omise.co: Request source using payment details api.omise.co-->>omise.js: Return source omise.js->>merchant: Merchant gets returned source merchant->>api.omise.co: Request charge using source and purchase details api.omise.co-xmerchant: Send "charge.create" webhook api.omise.co-->>merchant: Return charge merchant->>customer: Redirect to "authorize_uri" for pending charge customer->>api.omise.co: Provide charge authorization details at "authorize_uri" api.omise.co-->>customer: Redirect to "return_uri" api.omise.co-xmerchant: Send "charge.complete" webhook merchant-xcustomer: Send charge result (e.g. via email)

Authorizing the charge

Redirect the customer to location specified in authorize_uri so that 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 for you to be notified of the completion of a charge is 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 will be sent to this endpoint with the charge response embedded.

The key attribute for the event object contains charge.complete and the data attribute contains the charge object. See Events API for 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.

Failure Code Description
failed_processing General payment processing failure.
insufficient_balance Insufficient funds in the account or the payment method has reached its limit.
payment_cancelled Payment cancelled by payer.
timeout Payer did not take action before charge expiration.

Mobile Banking charges cannot be voided or refunded through Omise.

Limits

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

Next steps

เว็ปไซต์นี้มีการใช้คุกกี้เพื่อวิเคราะห์การใช้และปรับการใช้งานให้เหมาะกับท่าน เมื่อกดยอมรับหรือยังคงเข้าชมเว็บไซต์ต่อ เราถือว่าท่านยินยอมในการใช้งานคุกกี้ของเว็บไซต์ อ่านนโยบายความเป็นส่วนตัว