Localisation
The ekko SDKs and hosted ImpactPay pages support multiple languages. You control the language by passing the locale parameter when you initialise the SDK or create an ImpactPay session.
Supported languages
| Language | Locales |
|---|---|
| Arabic | ar-SA, ar-EG, ar-MA, ar-DZ, ar-TN, ar-LB, ar-SY, ar-JO, ar-PS, ar-IQ, ar-SD, ar-AE, ar-QA, ar-KW, ar-OM, ar-BH, ar-YE |
| English | en-GB, en-AU, en-NZ, en-IE, en-IN, en-ZA, en-SG, en-HK, en-US, en-CA, en-PH |
| Estonian | et-EE |
| French | fr-FR, fr-BE, fr-CH, fr-CA, fr-LU, fr-MC, fr-CI, fr-SN, fr-ML, fr-MA, fr-DZ, fr-TN, fr-CM, fr-HT, fr-RE, fr-PF, fr-GP, fr-MQ, fr-YT, fr-NC |
| German | de-DE, de-AT, de-CH |
| Italian | it-IT, it-CH |
| Latvian | lv-LV |
| Lithuanian | lt-LT |
| Portuguese | pt-PT, pt-AO, pt-MZ |
| Spanish | es-ES, es-MX, es-AR, es-CL, es-CO, es-PE, es-VE, es-UY, es-PY, es-BO, es-EC, es-CU, es-DO, es-PR, es-US, es-GT, es-SV, es-HN, es-NI, es-CR, es-PA, es-GQ |
If the requested locale isn't supported, the SDK and API default to en-GB.
Need a language that isn't listed?
Get in touch at [email protected].
How to set the locale
SDKs
Pass the locale option when you initialise the SDK:
import { Ekko } from '@ekko-earth/ekko-js'
const ekkoInstance = new Ekko('sandbox', {
locale: 'fr-FR'
})ImpactPay URL
The locale is included in the URL path:
https://impactpay.ekko.earth/fr-FR/carbon?referenceId=123456789Direct API integration
Pass the locale field in the request body when creating a quote:
{
"locale": "fr-FR"
}See Create a carbon quote or ImpactPay URL for the full request schemas.