Payment-method icon

TrueMoney Redirect Component v4.x.x integration

Add TrueMoney to an existing Components integration.

If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to the TrueMoney website where they can complete the payment.

When making an TrueMoney payment, you need to:

Requirements

Requirement Description
Integration type Make sure that you have built an Advanced flow Android Components integration.
Setup steps Before you begin, add TrueMoney in your Customer Area.

Show TrueMoney in your payment form

Include TrueMoney in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.

The response contains paymentMethod.type: truemoney.

We provide logos for TrueMoney which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, you need to:

  1. From your server, make a /payments request, specifying:

    • paymentMethod: Set this to truemoney.
    • returnUrl: URL to where the shopper should be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

    In the /payments response, check the action object for the information that you must use to redirect the shopper.

  2. Pass the action object to your client app.

Handle the redirect

  1. Use the Redirect Component to redirect the shopper to TrueMoney.
  2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:
    • details: The actionComponentData.details object from the Redirect Component.

You receive a response containing:

  • resultCode: Use this to present the payment 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:
  1. Create a shopper token.
  2. Use the token to make future payments for the shopper.

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.created
  • shopperReference: your unique identifier for the shopper.
  • eventId: the pspReference of 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: The storedPaymentMethodId from the recurring.token.created webhook or from additionalData.tokenization.storedPaymentMethodId if 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.

See also