Interface language support

An article about the capabilities of specifying the language used when the payment form is displayed.

Overview

The Payment Page text elements—various names (including names of fields and other), hints and messages (including error messages)—are the integral part of the payment form. These elements make the interface complete and clear and can have a significant impact on the user experience and the payment form conversion.

The Payment Page text elements make the interface complete and clear and can have a significant impact on the user experience and the payment form conversion.

Capabilities

In order to ensure the effectiveness of the Payment Page texts, the Ecommpay specialists work thoroughly on the content localisation and provide the capability of using any of the Payment Page languages from the regularly expanded basic set, while in the form customers can select any of the available languages. Along with that, due to different business nuances and for a better adaptation of Payment Page to a specific project, the merchant can discuss with the Ecommpay account manager the possibility to augment the list of available languages and specify the language relevant to a specific invocation of the payment form (using the customer's web service language preference, for example).

Figure 1. Using the capability of changing the language

In addition, it can be relevant to change the payment form design using the corresponding design builder.

Workflow

Every time the payment form opens, the customer can change the language of its interface to any of the basic set. Along with that, the form opens in the following default language (the options are provided in order of priority):

  1. The language of the payment form interface that was specified in the request for opening the form (details)—this language is used if it is supported for the project, and if it is not supported, then the default language (English) is used.
  2. The customer’s browser language—this language is used if it has been identified (via browser properties) and is supported for the project.
  3. English (used as a default language).

Specifying a language when opening the payment form

In order to localise the payment form for a particular session, submit the request for opening the payment form with the code of this language in the ISO 639-1 alpha-2 format specified in the language_code parameter. Within the payment platform, the codes are passed in the alpha-2 format of the ISO 639-1 standard, the codes of the languages that are not covered by the standard are coordinated with the merchant. It should be noted that the language set for invoking the form will also be used to generate additional notifications regarding events related to the payment (if this functionality is enabled in the project settings; see this article). This parameter also determines the language for generating notifications about the payment (details).

{
   "project_id": 93211,
   "payment_id": "423289",
   "payment_currency": "EUR",
   "payment_amount": 131970,
   "customer_id": "customer_772",
   "language_code": "de",    // language code
   "signature": "TSzdE5rJZaA9TYAWEKoGpfXriFf82MxF..."
}

This method of specifying the language means that it will determine the language of the payment form interface and the language of notifications and payment receipts (if applicable). However, if the specified language falls outside the project's supported language set, then English is used as the default.

Basic set of languages

Ecommpay supports displaying the payment form in the following languages.

Language Language code
English en
Estonian et
French fr
German de
Italian it
Latvian lv
Lithuanian lt
Portuguese pt
Spanish es
Ukrainian uk