Last updated

Integration

To integrate Atto Connect, you need only include a link to our hosted UI in a location of your choice in your application or on your website. This link will be given to you by your account manager once your account has been set up.

Parameters

The URL that launches Atto Connect can be provided with several parameters:

ParameterDescriptionMandatory
client_idYour application ID which will be provided by your account managerYes
config_idThe ID of the configuration you wish to load Atto Connect with. This ID is decided on by youNo - if not provided a default configuration will be used
customer_refYour reference for the end user going through the Atto Connect journeyYes
provider_idIf you already know which provider the user wishes to connect with, the ID can be provided to skip the bank selection and search part of the journeyNo
bank_codeIf you already know the end users bank code, the bank code can be provided to skip the bank selection and search part of the journey if we have a registered provider for the provided bank code. Note, the country_code parameter is also requiredNo
country_codeRequried parameter if passing in the bank_code parameterNo

Atto Connect can be setup to redirect to a URL. This can be setup by contacting support.

On redirection we will pass the following parameters to the redirection URL.

ParameterDescriptionMandatory
customer_refYour reference for the end user going through the Atto Connect journey (Max 255 Characters)Yes
statethe state of the end user journey. success or errorYes
erroran error code. see Atto Connect Errors for possible codes.Yes if state is error, No otherwise
consent_idUnique ID for the end-user's Consent that allows us to fetch their dataYes if state is success, No otherwise