Parameters

Required configuration#

To use Zūm Rails Aggregation, you must have a valid CustomerId, provided within your onboarding. If not, you can quickly grab it from Zūm Portal.

A customer Id for testing in sandbox looks like this: 94505e9d-342f-4a57-9365-778dbdd7be34

Parameter	Description	Default value	Required
customerid	Your CustomerId	-	yes

The base URL for Connector is:

PRODUCTION https://connector.aggregation.zumrails.com/?customerid=<YOUR-CUSOMTER-ID>.
SANDBOX https://connector-sandbox.aggregation.zumrails.com/?customerid=<YOUR-CUSOMTER-ID>.

Parameter	Description	Default value	Required
consent	When true, display the consent page. This page explains to the end user what information will be extracted and requires the end user to agree with the terms & conditions	true	false
accountselector	Display a page to select the preferred account, usually used for EFT payment initiation.	true	false
testinstitution	Display Zūm Rails test institution, used while you are testing	false	false
adduserinportal	Add connected users in Zūm Rails Portal	true	false
clientuserid	To be used when adduserinportal is true, this parameter enables you to inform your internal id for this user	undefined	false

Parameter	Description	Default value	Required
backbutton	Display the back button on the top left-hand corner	false	false
closebutton	Display the close button on the right-hand top corner	false	false
logo	Display the logo on the top of the screen	true	false
buttonbgcolor	The navigation buttons background color	#000000	false
buttontextcolor	The navigation buttons text color	#FFFFFF	false
logourl	Your logo url to be used on the UI. If not informed, Zūm Rails logo is the default one	-	false
tecurl	Your terms & conditions URL (consent page). When clicked, a new tab will be opened	-	false
institutionsearch	Display the Institution Search box	true	false
finishRredirecturl	An URL to redirect the page after the connection is completed	-	false
language	Change the connect language. There are two available options: en (english) and fr (french). If not set, the language will be chosen according to the browser language. English is applied if the given language is not available	-	false
accountselectorfooter	Display a extra text with customizable link action that trigger a callback. To define link area use html tag for anchor `<a>` with no additional attributes. You should handle the redirect on the callbacks for events listeners	-	false

Parameter	Description	Default value	Required
gettransactions	If you want to extract transactions	true	false
getstatements	If you want to extract pdf statements	false	false
getholderinformation	If you want to extract the account holder's name and address	true	false
datefrom	By default we extract information for the last 12 months. Use this field if you want to specify another range. Format (yyyy-MM-dd)	-	false

Parameter	Description	Default value	Required
extrafield1	And extra field so that you can add custom information, later receive it when the connection is completed	-	false
extrafield2	And extra field so that you can add custom information, later receive it when the connection is completed	-	false

Any parameters that are not true/false, like URLs or texts, must be encoded.

We recommend you use the Configure page to build your URL. No advanced technical knowledge is required.