Accept TrueMoney payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Requirements
| Requirement | Description |
|---|---|
| Integration type | Make sure that you have built an API-only integration. |
| Setup steps | Before you begin, add TrueMoney in your test Customer Area. |
Build your payment form for TrueMoney
Include TrueMoney in the list of available payment methods.
We provide logos for TrueMoney which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
- countryCode: Any supported country/region. For example, TH.
- amount.currency: Any supported currency. For example, THB.
- amount.value: The value of the payment, in minor units.
- channel: Specify Web, iOS, or Android.
The response contains paymentMethod.type: truemoney for Web, or for iOS and Android.
Make a payment
From your server, make a /payments request, specifying:
paymentMethod.type: truemoney
In the /payments response, check the action object for the information that you must use to redirect the shopper.
Handle the redirect
-
To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response, taking into account the following recommendations:-
When using the HTTP GET method:
For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView. -
Redirection for mobile integrations:
For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.
-
-
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: object that contains the URL-decodedredirectResultreturned when the shopper was redirected back to your site.
-
In the response note the following:
resultCode: use this to present the result to your shopper.pspReference: our unique identifier for the transaction.
Present the payment result
Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.
The resultCode values you can receive for TrueMoney are:
| resultCode | Description | Action to take |
|---|---|---|
| Authorised | The payment was successful. | Inform the shopper that the payment has been successful. |
| Cancelled | The shopper cancelled the payment while on TrueMoney's website. | Ask the shopper whether they want to continue with the order, or ask them to select a different payment method. |
| Error | There was an error when the payment was being processed. | Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error. |
| Pending or Received |
The shopper has completed the payment but the final result is not yet known. | Inform the shopper that you have received their order, and are waiting for the payment to be completed. To know the final result of the payment, wait for the AUTHORISATION webhook. |
| Refused | The payment was refused by the TrueMoney. | Ask the shopper to try the payment again using a different payment method. |
If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment. The webhooks you can receive for TrueMoney are:
| eventCode | success field | Description | Action to take |
|---|---|---|---|
| AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
| AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
| OFFER_CLOSED | true | The shopper did not complete the payment. | Cancel the order and inform the shopper that the payment timed out. |
Recurring payments
TrueMoney supports recurring transactions. To make recurring transactions, you need to:Create a token
To create a token, include in your /payments request:
storePaymentMethod: true- shopperReference: Your unique identifier for the shopper.
This triggers the recurring flow, where the shopper logs in to their TrueMoney account, and then confirms the recurring transaction.
For the recurring flow to be completed, always make the /payments/details request, otherwise the payment method will not be stored.
When the payment has been settled, you receive a recurring.token.created webhook containing:
type: recurring.token.createdshopperReference: your unique identifier for the shopper.eventId: thepspReferenceof the initial payment.storedPaymentMethodId: the token that you need to make recurring payments for this shopper.
Make sure that your server is able to receive the Recurring tokens life cycle events webhook. You can set up this webhook in your Customer Area.
Make a payment with a token
To make a payment with the token, include in your /payments request:
-
paymentMethod.storedPaymentMethodId: ThestoredPaymentMethodIdfrom the recurring.token.created webhook or fromadditionalData.tokenization.storedPaymentMethodIdif you are retrieving the token synchronously.You can also get this value using the /listRecurringDetails endpoint.
-
shopperReference: The unique shopper identifier that you specified when creating the token. -
shopperInteraction: ContAuth -
recurringProcessingModel: Use Subscription for a series of transactions following a fixed time interval or UnscheduledCardOnFile for contracts with non-fixed time interval.
Test and go live
To test successful TrueMoney live payments, you need to use a real mobile number registered with a TrueMoney account.
If you are encountering issues with testing TrueMoney payments, contact our Support Team.
Check the status of TrueMoney test payments in your Customer Area > Payments > Payment list.
Before you can accept live TrueMoney payments, you need to submit a request for TrueMoney in your live Customer Area.