PayLink Multilingual Support Overview
  • 25 Jun 2024
  • 2 Minutes to read
  • Dark
    Light

PayLink Multilingual Support Overview

  • Dark
    Light

Article summary

The Data Dictionary provides multilingual support, allowing Admins to establish a default language that serves as the primary language for all users. For example, you can override button labels and other static text on your PayLinks.

Admins can also override the default language and customize users' language experiences when specific predefined criteria are met. For example, an Admin can change the language for users in a particular region.

Content will be presented in a user’s preferred language or default to English if a language isn’t pre-selected. Users won’t have to manually select their language each time they interact with the system, and they can change the displayed language according to their preferences.

New Fields

The Transaction object now includes two new fields, the Data Dictionary Group field and the PayLink Display Language field.

Data Dictionary Group

The Data Dictionary Group field creates a link between the Data Dictionary Group and the Transaction records.

  • Field Name: Data Dictionary Group
  • API Name: bt_stripe__Data_Dictionary_Group__c
  • Data Type: Lookup(Data Dictionary Group)
  • Description: Select the appropriate Data Dictionary Group containing the translated override values (Data Dictionary Entries) for the chosen language.

PayLink Display Language

The PayLink Display Language field contains a list of languages that an Admin can choose from to display to the PayLink to the end user.

• Field Name: PayLink Display Language
• API Name: PayLink_Display_Language__c
• Data Type: picklist
• Description: List of supported display languages for the PayLink. This field is set to English by default.

Warning

Do not use the new Display Language (Display_Language__c) and Data Dictionary Group (bt_stripe__Data_Dictionary_Group__c) fields on the PayLink Configuration object. They are not functional.

How It Works

The following logic describes how the Data Dictionary Group / Data Dictionary Entry records interact with the PayLink Display Language field.

  • PayLink labels are displayed in English, the default language, when either of the following is true.
    • The Transaction’s PayLink Display Language and Data Dictionary Group fields are blank.
    • The Transaction’s PayLink Display Language field is blank, and the Data Dictionary Group does not have a Data Dictionary Entry for English.
  • PayLink labels use a Data Dictionary Entry’s values if the attached Transaction’s Data Dictionary Group has a Data Dictionary Entry record that uses the same language as the Transaction’s PayLink Display Language.
  • PayLink labels are displayed in the selected Transaction PayLink Display Language if a Data Dictionary Group does not include a Data Dictionary Entry record for the selected PayLink Display Language.
  • PayLink labels are displayed in English if a Data Dictionary Group has a Data Dictionary Entry record with Language / Locale = “English,” and the Transaction’s PayLink Display Language field is blank.
  • PayLink labels are displayed in the selected Transaction’s PayLink Display Language when the Transaction’s Data Dictionary Group field does not have a value.