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.

The customer Id for testing in sandbox is the same as your API username found under the API settings in your portal.

Basic configuration#

ParameterDescriptionDefault valueRequired
customeridYour CustomerId-yes

The base URL for Connector is:


Configure the user experience#

ParameterDescriptionDefault valueRequired
consentWhen 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 & conditionstruefalse
accountselectorDisplay a page to select the preferred account, usually used for EFT payment initiation.truefalse
testinstitutionDisplay Zūm Rails test institution, used while you are testingfalsefalse
adduserinportalAdd connected users in Zūm Rails Portaltruefalse
clientuseridTo be used when adduserinportal is true, this parameter enables you to inform your internal id for this userundefinedfalse
institutionidInform the bank institution id to be used as the selected institutionundefinedfalse

The field institutionid can be defined with one for the institutions id:

ATB Financialbd32c118-54b0-44f4-bb3d-53f5eabb71ec
BMO - Bank of Montreal22d5ba65-9b69-4f29-b69f-b520c8d7bda1
Canadian Western Bankf48f6332-5b70-41eb-9c36-05cd68fa200d
Coast Capital Savings497bfa7a-b34d-402b-866d-c6a941c6eb56
Equitable Bank9f3cba3e-7748-4c1c-8371-3da01655d059
Laurentian Bank of Canadaa54fdeda-e056-4013-98c6-3b8dc14b8458
Meridian Credit Union Limiteda44eaf9a-05e2-4145-8177-477a41801e1d
National Bank of Canada8824280d-7c62-4194-87bc-a363804f6013
Royal Bank0484a92f-d95a-4027-9375-bdf2a1dab0dc
Simplii Financialc1780b1e-ed81-40e9-93b1-4dc747eb662d
TD - Canada Trust000e1be4-42a2-4476-8985-7b330638a359
The Bank of Nova Scotia06b4c757-a7cf-45df-8b3b-80e97324286c
Vancouver City Saings Credit Uniond6e71c0d-9383-4e69-b3e0-8da2f3beb04f
Zūm Rails Testing Bank *2a778283-d87a-4b8c-aa3e-af1ed16bc486
  • Zūm Rails Testing Bank is only available in non productive environment.

Configure the user interface#

ParameterDescriptionDefault valueRequired
backbuttonDisplay the back button on the top left-hand cornerfalsefalse
closebuttonDisplay the close button on the right-hand top cornerfalsefalse
logoDisplay the logo on the top of the screentruefalse
buttonbgcolorThe navigation buttons background color#000000false
buttontextcolorThe navigation buttons text color#FFFFFFfalse
logourlYour logo url to be used on the UI. If not informed, Zūm Rails logo is the default one-false
tecurlYour terms & conditions URL (consent page). When clicked, a new tab will be opened-false
institutionsearchDisplay the Institution Search boxtruefalse
finishredirecturlAn URL to redirect the page after the connection is completed (URL must include https://)-false
languageChange 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
accountselectorfooterDisplay 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

Configure the data to extract#

ParameterDescriptionDefault valueRequired
gettransactionsIf you want to extract transactionstruefalse
getstatementsIf you want to extract pdf statementsfalsefalse
getholderinformationIf you want to extract the account holder's name and addresstruefalse
datefromBy default we extract information for the last 12 months. Use this field if you want to specify another range. Format (yyyy-MM-dd)-false

Extra configuration#

ParameterDescriptionDefault valueRequired
extrafield1And extra field so that you can add custom information, later receive it when the connection is completed-false
extrafield2And 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.