TrueMoney Wallet

Enable your customers to make payments using their TrueMoney Wallet. Eliminating the need to enter their card details can help your customers checkout faster.

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

The customer is required to have a mobile number registered with TrueMoney Wallet.

How To Enable

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

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

Payment Flow

Customers who choose to pay via TrueMoney Wallet go through a redirect payment flow using a one-time password (OTP). This means that after they input their mobile number ❸, they are prompted to authorize and confirm the payment amount using a one-time password sent to their phone ❹. Upon completion, the customer is redirected back to your website ❺.

Implementation

To create a TrueMoney Wallet charge, make the following API requests.

1. Create a new payment source 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 TrueMoney Wallet source on the client (a customer's browser or mobile phone). Use your secret key to create the TrueMoney Wallet 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

TrueMoney Wallet payments are implemented as sources. When the customer confirms that they wish to pay with this payment method, create a new source specifying the type, amount, currency, and phone_number.

The following examples demonstrate the creation of a new TrueMoney Wallet source for ฿4,000. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with your test public key found on the dashboard: https://dashboard.omise.co/test/keys

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

Omise.setPublicKey(omise_public_key);

Omise.createSource('truemoney', {
  "amount": 400000,
  "currency": "THB",
  "phone_number": "0812345678"
}, function(statusCode, response) {
  console.log(response)
});

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

curl https://api.omise.co/sources \
  -X POST \
  -u $OMISE_PUBLIC_KEY: \
  -d "amount=400000" \
  -d "currency=THB" \
  -d "type=truemoney" \
  -d "phone_number=0812345678"

{
  "object": "source",
  "id": "src_test_5hn9a2i4a9702dqzbay",
  "livemode": false,
  "location": "/sources/src_test_5hn9a2i4a9702dqzbay",
  "created_at": "2019-10-22T10:37:42Z",
  "type": "truemoney",
  "flow": "redirect",
  "amount": 400000,
  "currency": "THB",
  "mobile_number": "0812345678",
  "phone_number": "0812345678",
  "references": null,
  "name": null,
  "email": null,
  "barcode": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "installment_term": null,
  "zero_interest_installments": null,
  "scannable_code": null
}

Creating a Charge

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

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

The following example demonstrates how to create a new TrueMoney Wallet charge using curl. Replace $OMISE_SECRET_KEY with your test secret key found on the dashboard: https://dashboard.omise.co/test/keys. Replace $SOURCE_ID with the id of the source.

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

{
  "object": "charge",
  "id": "chrg_test_5hn9a2kb2p1m8k3abbm",
  "livemode": false,
  "location": "/charges/chrg_test_5hn9a2kb2p1m8k3abbm",
  "created_at": "2019-10-22T10:37:42Z",
  "amount": 400000,
  "currency": "THB",
  "funding_amount": 400000,
  "funding_currency": "THB",
  "fee": 14600,
  "fee_vat": 1022,
  "interest": 0,
  "interest_vat": 0,
  "net": 384378,
  "description": null,
  "metadata": {},
  "status": "pending",
  "capture": true,
  "authorized": false,
  "schedule": null,
  "reversed": false,
  "reversed_at": null,
  "expires_at": "2019-10-29T10:37:42Z",
  "expired": false,
  "expired_at": null,
  "voided": false,
  "paid": false,
  "paid_at": null,
  "transaction": null,
  "refunded_amount": 0,
  "refunds": {
    "object": "list",
    "from": "1970-01-01T00:00:00Z",
    "to": "2019-10-22T10:37:43Z",
    "offset": 0,
    "limit": 20,
    "total": 0,
    "order": "chronological",
    "location": "/charges/chrg_test_5hn9a2kb2p1m8k3abbm/refunds",
    "data": []
  },
  "link": null,
  "return_uri": "http://example.com/orders/345678/complete",
  "failure_code": null,
  "failure_message": null,
  "card": null,
  "customer": null,
  "ip": null,
  "dispute": null,
  "source": {
    "object": "source",
    "id": "src_test_5hn9a2br5cekylu1wu8",
    "livemode": false,
    "location": "/sources/src_test_5hn9a2br5cekylu1wu8",
    "created_at": "2019-10-22T10:37:41Z",
    "type": "truemoney",
    "flow": "redirect",
    "amount": 400000,
    "currency": "THB",
    "mobile_number": "0812345678",
    "phone_number": "0812345678",
    "references": null,
    "name": null,
    "email": null,
    "barcode": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "installment_term": null,
    "zero_interest_installments": null,
    "scannable_code": null
  },
  "platform_fee": {
    "percentage": null,
    "fixed": null,
    "amount": null
  },
  "disputable": false,
  "capturable": false,
  "reversible": false,
  "refundable": false,
  "authorize_uri": "https://pay.omise.co/payments/pay2_test_5hn9a2kf68tfai6gvh3/authorize"
}

Creating a Source and Charge

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

curl https://api.omise.co/charges \
  -X POST \
  -u $OMISE_SECRET_KEY: \
  -d "amount=400000" \
  -d "currency=thb" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source[type]=truemoney" \
  -d "source[phone_number]=0812345678"

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.

Authorizing the Charge

Redirect the customer to the location specified in authorize_uri. At this webpage, the customer enters their one-time password.

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, retrieving 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 has updated to successful, you got paid. If the value of status has updated to failed, check the failure_code and failure_message in the charge object for an explanation.

Possible failure codes are listed below.

Voids and Refunds

TrueMoney Wallet charges cannot be voided, only refunded. Refunds can only be made within 30 days of charge creation.

See the Refunds API documentation for information on how to refund a TrueMoney Wallet charge.

Limits

• Minimum: 2000 (฿20)
• Maximum: 15000000 (฿150,000)

In addition to the above per transaction limits, the daily maximum amount that a given customer can charge depends on that customer's TrueMoney Wallet verification status.

See the TrueMoney FAQ (Thai) for more information.

Next Steps

• Charge API
• Source API
• Webhooks API