Public preview

Localisation Public preview

Learn how to provide translations for Stripe APIs that support localisation.

You can display information to users in their preferred language by providing localised content for supported APIs.

1. Stripe provides the translatable fields for an API Group in the related setting 2.0 format .
2. You download and translate the content for your target languages.
3. Your application serves the translated content to users according to their location.

Localisable API format

Endpoints that support localisation expose a format within the API specifically to allow self-localised strings:

{
 "localization_key": "payout_methods.bank_account.account_number",
 "content": "Account Number"
}

This format consists of two keys:

• localization_key : identifies a language specific piece of content that integrators can use in their own localisation back end to display the corresponding translation.
• content : is the translated copy that corresponds to the key.

Supported APIs

The PayoutMethodsBankAccountSpec endpoint allows you to localise form labels when onboarding users’ bank accounts.

Download the the related setting file

Stripe provides a list of translatable fields in the related setting 2.0 format. Each field contains a stable identifier key (unit ID in the the related setting file), an English translation, as well as a contextual description.

The following example shows a translatable field in the the related setting file:

<unit id="payout.methods_bank.account_account.number">
 <notes>
 <note id="n1">Form field label for bank account number.</note>
 </notes>
 <segment id="s1">
 <source>Account Number</source>
 </segment>
</unit>

Integrate the following file into your localisation pipeline so translators can accurately translate the content based on the context provided in the description.

Money management localisation file: stripe_api_localizations-money_movement.xlf

Translate every field provided in the file for all countries your business serves or plans to serve to avoid a Mixed Language Experience (MLX). An MLX is when users see only a subset of fields in their preferred language. This might happen if you translate only a subset of fields for a given country, but Stripe requires your users to submit their information for all fields. Seeing only a few fields in their preferred language and the other fields in US English (the Stripe default language and locale) can confuse users and degrade their trust in your business.

Changes to Localisable APIs

Stripe protects your localised APIs from introducing an MLX. If we add new fields to a localised API during a minor release, we require you to resubmit the current translation file version you support for the API. We don’t return the new fields in the API response until you provide an updated translation file version.