WebFormProps | @finapi/web-form

Web Form properties.

Hierarchy

WebFormProps

Index

Properties

Optional backToAppUrl

backToAppUrl: string

This is useful only for the case when the web form is embedded inside a native app and the end-user connects a redirect bank, as this will result in the end-user being redirected outside your application. After the user finalizes the authentication on bank side, the bank will redirect the end-user to finAPI domain. If the parameter is specified, then we will redirect the end-user back to the given URL, so that end-user comes back to your application. For this to work correctly, please make sure you correctly registered your application Universal Link (iOS)/AppLink(Android), so that your application can catch the redirect.

Optional customerSupportUrl

customerSupportUrl: string

If specified, then in case when Web Form ends with error, in addition to the Close action an additional action to Open Customer Service is offered to the user. URL will open in new tab.

Optional language

language: WebFormLanguage

It enables the setting of the language for the Web Form. The visibility of the language select item is still controlled solely by the Web Form Profile configuration. The language selected through the select item is also remembered for the current Access User and takes precedence over the value of this property.

Optional layoutConfig

layoutConfig: LayoutConfig

Responsive Layout Configuration. The sizes mean that Web Form will be "forced" to one specific layout and resizing the browser window won't change anything. Object value allows the setup of custom breakpoints. Be aware, that always breakpoints are set on the size of the browser window and not on the size of the container element.

Optional noMargins

noMargins: string

Removes margins on the edges and some spacing inside webform.

Optional targetEnvironment

targetEnvironment: Environment

This property is for testing and development purposes only.

This property allows specifying which finAPI server the Web Form will communicate with. New features are released environment by environment. Sometimes it is necessary to test them before they reach the live production environment. This option will influence where the Loader fetches the Web Component bundle JS file from, and to which backend server the Web Form will be sending requests. Properties targetUrl and sourceUrl take precedence over this property.

example: FinApiWebForm.load(container, { token: "XXXXX", targetEnvironment: "sandbox" })
deprecated: To connect to the sandbox environment, set https://webform-sandbox.finapi.io as the value for the property targetUrl.

Optional targetUrl

targetUrl: string

URL of the finAPI server that Web Form will communicate with. If this property is missing, the URL will be resolved based on the 'targetEnvironment' property. If both 'targetUrl' and 'targetEnvironment' are not provided, Web Form will communicate with the Live finAPI environment. The server must belong to finAPI domains '.finapi.net', '.finapi.io'.

example: https://webform-sandbox.finapi.io

token

token: string

Web Form security token for one-time use.