このページは現在翻訳中です。

TrueMoney App Redirection NEW

このページで扱うトピック

Accept online payments from TrueMoney users through your website using the TrueMoney payment method.

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

For the legacy integration with TrueMoney Wallet using the redirect payment flow and one-time password, please refer to the TrueMoney Wallet.

How to enable

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

To enable TrueMoney App Redirection, send an email requesting this feature to support@opn.ooo. You will need to review and accept new terms and conditions.

Payment flow

TrueMoney App Redirection supports payment on mobile application and websites. Customers paying via TrueMoney App Redirection go through an app_redirect payment flow. This means they are redirected from your website or mobile application to TrueMoney App Redirection secure checkout page where they authorize and confirm the payment. For mobile, a customer can use TrueMoney App Redirection app to complete the payment. For website payment, a customer can either scan the QR code using the TrueMoney App Redirection app on their phone or login into their TrueMoney App Redirection account to complete the payment and if a customer does not proceed to the application within 3 minutes, the payment will be expired.

The following screenshots demonstrate two flows: one by mobile and another on desktop QR code.

Using a mobile

Points Select

The customer chooses the wallet they want to pay with and they will redirected to their wallet app to confirm the payment then the related payment details are shown. The customer can be redirected to the merchant's confirmation details page by pressing Back to merchant.

Using a desktop browser

Points Select

The customer chooses the wallet they want to pay with ❶, after that a QR code will be shown ❷. The customer can either use the QR scanner from the corresponding app or from their mobile to scan ❸. The customer scans the QR code ❹. The customer is shown the summary page before confirming 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 ➐.

Implementation

To create a charge using TrueMoney App Redirection, make the following API requests.

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

Parameter Type Description
amount integer (required) See Limits
currency string (required) THB
type string (required) truemoney_jumpapp

The following examples demonstrate the creation of a new TrueMoney App Redirection 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('truemoney_jumpapp', {
  "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=truemoney_jumpapp"
{
  "object": "source",
  "id": "src_test_5ywrhgr7pplufw6apja",
  "livemode": false,
  "location": "/sources/src_test_5ywrhgr7pplufw6apja",
  "amount": 400000,
  "barcode": null,
  "bank": null,
  "created_at": "2024-02-27T10:25:45Z",
  "currency": "THB",
  "email": null,
  "flow": "app_redirect",
  "installment_term": null,
  "ip": "35.198.236.178",
  "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": "truemoney_jumpapp",
  "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=http://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"
{
  "object": "charge",
  "id": "chrg_test_5ywrhgu0ourwvoe4m5b",
  "location": "/charges/chrg_test_5ywrhgu0ourwvoe4m5b",
  "amount": 400000,
  "acquirer_reference_number": null,
  "net": 0,
  "fee": 0,
  "fee_vat": 0,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 400000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": null,
    "fee_rate": null,
    "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_5ywrhgu0ourwvoe4m5b/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2024-02-27T10:25:46Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_5ywrhghsjgs1xx3fihf",
    "livemode": false,
    "location": "/sources/src_test_5ywrhghsjgs1xx3fihf",
    "amount": 400000,
    "barcode": null,
    "bank": null,
    "created_at": "2024-02-27T10:25:44Z",
    "currency": "THB",
    "email": null,
    "flow": "app_redirect",
    "installment_term": null,
    "ip": "35.198.236.178",
    "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": "truemoney_jumpapp",
    "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_5ywrhgu1t3ix59xsul6/authorize",
  "return_uri": "http://example.com/orders/345678/complete",
  "created_at": "2024-02-27T10:25:45Z",
  "paid_at": null,
  "expires_at": "2024-03-05T10:25:45Z",
  "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,
  "can_perform_void": false,
  "approval_code": 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]=truemoney_jumpapp" \

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.

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 the location specified in authorize_uri so that they can authorize the charge.

The merchant can simulate this authorization phase in test mode by visiting 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 specified in return_uri.

Receiving the charge completion event

The best way to be notified about the completion of a charge is 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.

Failure Code Description
failed_processing General payment processing failure.

Voids and Refunds

TrueMoney charges can only be voided on the same day as the transaction authorization. Refunds can only be made within 30 days after charge creation.

Cancel within a day (Voids) Cancel next day
(Refunds)
Payment Methods Fully Partial Fully Partial
TrueMoney Wallet
(Wallet Balance)
Bank Account
Credit Card
Pay Next
Pay Next Extra

See the Refunds API documentation for information on refunding a TrueMoney charge.

Limits

  • Minimum: 10000 (THB100.00)
  • Maximum: 5000000 (THB50,000.00)

How to check the public key and secret key

For information on how to obtain and check the public and secret keys, please refer to this document.

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら