Select a Method - PayLink

  • Updated on Jun 3, 2025
  • Published on Jun 25, 2024
  • 3 minute(s) read
Prev Next

Data Dictionary

The PayLink’s field labels, button text, and checkout screen text will be written in the language selected in the PayLink Display Language field on the Transaction record. If the PayLink Display Language field is blank, the labels, button text, and text on the checkout screen will default to English.

The translations on the PayLink can also be overridden by using the Data Dictionary. Use the instructions below to create a Data Dictionary Group from the Transaction record.

Required Licenses and Permission Sets

To use the Data Dictionary feature, you must have a Blackthorn Payments license, as well as access to the following fields:

  • Create/Read/Update - Data Dictionary Group
  • Create/Read/Update - Data Dictionary Entry

Supported Languages

We do not currently support all languages. The following is a list of the languages we support.

  • Arabic
  • Chinese (Simplified)
  • Chinese (Traditional)
  • Czech
  • Danish
  • Dutch
  • Finnish
  • French
  • German
  • Haitian Creole
  • Hindi
  • Hmong
  • Hungarian
  • Indonesian
  • Italian
  • Japanese
  • Korean
  • Norwegian
  • Polish
  • Portuguese
  • Romanian
  • Russian
  • Somali
  • Spanish
  • Swedish
  • Thai
  • Turkish
  • Vietnamese

One-to-One Relationships

A Data Dictionary Entry record contains three important fields: Value, Key, and Language / Locale. In each Data Dictionary Entry record, the fields interact as follows:

  • There can be only one value in the Language / Locale field.
  • Each Key is associated only with one Value.

Creating a second line in the Data Dictionary Entry using the same Key as the first line but with a different Value will replace the first Value with the new one.

Example:

  • Line 1: Key = "LBL_CHECKOUT" and Value = "Checkout"
  • Line 2: Key = "LBL_CHECKOUT" and Value = “Proceed”
  • Result: The Attendee will see “Proceed.”

Create a Data Dictionary Group

If you want to override out-of-the-box values, the first step is to create a Data Dictionary Group and populate it with Data Dictionary Entries.

  1. In the App Launcher, enter and click “Data Dictionary Group.”
  2. Click New.
    CreateDataDictionaryGroup_Object1
  3. Enter a Data Dictionary Group Name.
  4. Click Save.
    CreateDataDictionaryGroup_New1
  5. Click New next to Data Dictionary Entry.
    CreateDataDictionaryGroup_NewEntry1
  6. The Data Dictionary Values field contains the Language / Locale, Key, and Value. Click the PayLink Data Dictionary (a Google document) for Key and Value information.
  7. Here are few frequently used Data Dictionary values and their keys:
    • Key = "LBL_TOTAL" and Value = "Total"
    • Key = "LBL_INVOICE" and Value = "Invoice"
    • Key = "LBL_BALANCE_PAID" and Value = "Balance Paid"
    • Key = "MSG_PROCESSING_TRANSACTION" and Value = "Processing transaction..."
    • Key = "MSG_AUTHORIZE_CREDIT_CARD_WITH_NAME" and Value = "I authorize (XYZ) to charge my credit card."
  8. Select the Language / Locale you'd like to change.
  9. Enter a Key and Value.
  10. Click Add Row to add additional entries or click Save.
  11. Click Back to return to the Data Dictionary Group record.
    CreateDataDictionaryGroup_EntryKeyValue1

If you need to add additional keys to the Data Dictionary Entry, click the menu (upside down triangle) next to the Data Dictionary Entry. From there, click Add Row to add a new Key and Value. When you are done, click Save and Back to return to the Data Dictionary Group.

USE CAPITAL LETTERS

In the Key field, use capital letters.

Example

For this example, we will set Language / Locale = "German". Now, we can select any word or phrase to replace an action with. Set Key = “LBL_DUE_DATE“ and Value = “Faelligkeitsdatum”. Make sure to use all capital letters for the Key.

DocuLink_DataDictionary_German_1

DocuLink_DataDict_German_2

Add a Data Dictionary Group to a PayLink Configuration

  1. Open an existing PayLink Configuration record or create a new one.
  2. Click the Pencil icon next to the Data Dictionary Group field.
  3. Select a Data Dictionary Group.
  4. Click Save.

Default Language

Change the Default Language

The following functionality has been added.

  • PayLink checkout will be displayed in the language selected on the PayLink Configuration record.
  • Labels will default to English if the Display Language field on the PayLink Configuration record is left blank.
  • The language on labels and buttons can be overwritten with a Data Dictionary Group record containing the matching Key and Value.
  • The date will be formatted based on the language selected on the PayLink Configuration record. If no language is selected, the date format will be based on the browser’s location.

Translate a PayLink Configuration Record

  1. Go to a Transaction record.
  2. Click an existing PayLink Configuration or create a new one.
  3. Select a Display Language.
  4. Click Save.

Override a Specific Key

If you are looking for a specific Key you want to override but can't find it, click the PayLink URL field, and swap the language in the domain with "debug". You will see the keys on a specific PayLink, or in other words, the debugged version of the PayLink with each field identified.

See the images below to see how swapping "https://dev.paylink.blackthorn.io" with "https://dev.paylink.blackthorn.io/debug/" shows the keys.

PayLink URL – Original

PayLink URL DeBug_Before

PayLink URL – Debug

PayLink URL_DeBug_After