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 support once your environment has been set up.
Parameters
The URL that launches Atto Connect can be provided with several parameters:
| Parameter | Description | Mandatory |
|---|---|---|
| client_id | Your application ID which will be provided by your account manager | Yes |
| config_id | The ID of the configuration you wish to load Atto Connect with. This ID is decided on by you | No - if not provided a default configuration will be used |
| customer_ref | Your reference for the end user going through the Atto Connect journey | Yes |
| provider_id | If 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 journey | No |
| bank_code | If 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 required | No |
| country_code | Requried parameter if passing in the bank_code parameter | No |
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.
| Parameter | Description | Mandatory |
|---|---|---|
| customer_ref | Your reference for the end user going through the Atto Connect journey (Max 255 Characters) | Yes |
| state | the state of the end user journey. success or error | Yes |
| error | an error code. see Atto Connect Errors for possible codes. | Yes if state is error, No otherwise |
| consent_id | Unique ID for the end-user's Consent that allows us to fetch their data | Yes if state is success, No otherwise |