Localisation

By specifying the locale parameter during SDK initialisation as described below, you can change the language and formatting of text displayed to better suit the needs of your international customers. Such changes are applied to field names, buttons (e.g. “Pay”) and notification messages displayed to the customer during the checkout process (e.g. Success or Declined).

Locale for form elements

All translations are already bundled with the SDK. Appropriate texts on UI elements, which are part of the SDK, will automatically be translated based on the OS system language setting.

locale requires a language and country to be specified, in the format shown below. We support the following values:

Locale for gateway response

By also updating the payload within the JWT to include the locale field, you can update your checkout to translate response messages returned by the gateway during the payment session.

locale requires a language and country to be specified, in the format shown below. We support the following values:

(Example payload)

{
  "iss":"jwt-test",
  "iat":16094035377,
  "payload":{
    "accounttypedescription":"ECOM",
    "baseamount":"1050",
    "currencyiso3a":"GBP",
    "locale":"en_US",
    "sitereference":"test_site12345",
    "requesttypedescriptions":["THREEDQUERY","AUTH"],
    "termurl":"https:\/\/payments.securetrading.net\/process\/payments\/mobilesdklistener"
  }
}

We recommend that you use the OS language for displaying the gateway responses. If the device language is not supported, your app should omit the locale from the JWT.

When providing an app in Norwegian language, we recommend that “no_NO” is submitted for locale in the JWT instead of “nb_NO” or “nn_NO”, as this is the most common Norwegian language setting for Android devices.

Retrieving the current system locale in Android can be achieved by:

v24 of API and newer

resources.configuration.locales.get(0)

getResources().getConfiguration().getLocales()[0]

v32 of API and older

resources.configuration.locale

getResources().getConfiguration().getLocale()

Custom translations

You can specify custom translations for elements on the checkout form that will override the default text displayed.

This also allows you to provide alternative wording to the default phrases returned to better reflect your brand’s voice (e.g. re-wording the default error messages returned to customers).

To specify custom translations, you will need to override the default string resources in the language-specified strings.xml files, as is used in the standard Android localisation mechanism.

Default string resources to override

<string name="pvc_pan_label">Card number</string>
<string name="pvc_expiry_date_label">Expiry date</string>
<string name="pvc_expiry_date_hint">MM/YY</string>
<string name="pvc_cvv_label">CVV</string>
<string name="pvc_pay_button_text">Pay</string>
<string name="pvc_input_error_text">Invalid field</string>

<string name="tdswa_webViewError_message">A networking error occurred while processing your payment.\nPlease try again later.</string>
<string name="tdswa_goBack_label">Go back</string>
<string name="tdswa_process_in_progress">Process in progress</string>
<string name="tds_challenge_popup_cancel_button">Cancel</string>
<string name="tds_challenge_popup_title">SECURE CHECKOUT</string>

Example: When overriding “Pay” to be “Pay now” in the payment form, you would need to create a strings.xml file for en-GB or en-US in your app resources and include the following:

<string name="pvc_pay_button_text">Pay now</string>

The same mechanism can be used for the creation of unsupported language versions.