@qonto/embed-sdk / <internal> / InitializeParams

Interface: InitializeParams

An object with the parameters to initialize the SDK. The only required parameter is the accessToken.

Properties

accessToken?

optional accessToken: string
The access token to authenticate the user. This has to be previously generated using the OAuth authentication flow.

branch?

optional branch: "master" | "sandbox" | "qa"
Optional parameter to set the SDK’s branch. This is only relevant when the environment is set to 'staging'. The possible values are BRANCHES.MASTER, BRANCHES.SANDBOX and BRANCHES.QA. If not provided, the SDK will default to 'MASTER'.

environment?

optional environment: "production" | "staging" | "local"
Optional parameter to set the SDK’s environment. If not provided, the SDK will default to 'production'. Use ENVIRONMENTS.STAGING to set the SDK to staging.

locale?

optional locale: string
The locale to use for the SDK. This is optional, and if not provided, it will default to English. Setting the locale will make the SDK render its UI in the specified language.

operationSettings?

optional operationSettings: OperationSettings

stagingToken?

optional stagingToken: string
The staging token allows users outside Qonto to access the staging environment. This is helpful for testing purposes, and it is irrelevant in production.