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.

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

Basic configuration#

Parameter	Description	Default value	Required
customerid	Your CustomerId	-	yes

The base URL for Connector is:

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

Configure the user experience#

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 ACH 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.	false	false
clientuserid	To be used when adduserinportal is true, this parameter enables you to inform your internal id for this user	undefined	false
institutionid	Inform the bank institution id to be used as the selected institution	undefined	false

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

Institution	Id
Bank of America	67e56976-80c6-4321-b93a-969b8685c848
BMO (US)	12112c05-3eec-4987-9740-508ab3b0aa07
Capital One	1f3a818c-d396-4ccb-af3b-d201e1c0d355
Charles Schwab US	c48d024d-5ab4-4438-b89a-6f60c9257ed6
Chase Bank	374970ad-229d-4f75-a9e6-905330c22f57
Citibank	d98c818d-5ae7-4d78-b83c-25c268272951
Citizens Bank	621787f4-7dfe-4d90-afe8-dc5faa84a589
Fifth Third Bank	6ac60d50-cd6b-4aef-91fb-d9d31a37c3c4
First Citizens Bank	791f1e6a-0295-438e-9feb-8a4f31f779d3
Goldman Sachs - Transaction Banking	4230c3ae-d6a7-4dec-b63f-90d10e5657cf
HSBC (US)	b7c13426-5e6f-452c-9f03-0f49a7cd4230
Huntington Bank	73c6e5ef-ba26-44bc-81f6-5f0c87cd46a7
JP Morgan - Access	db185a9d-2f14-41ad-ae2b-a5cde14c9bcf
Key Bank	433267c4-f5dc-4401-a450-158148f8ddcc
PNC Bank	a7efbbac-950f-42b4-a056-b98aa3c73330
TD Bank (US)	20044acd-32e4-4711-941d-0c9198c9aeb6
The Bank of New York Mellon	951e451c-1a7a-41c4-b062-f37ac573f348
Truist	58bc613f-9f4a-442b-8392-ca0ebba3bac0
U.S. Bank	34fa35f1-3abf-4d80-acf1-52d58c954859
Wells Fargo	acb7648d-888b-436b-be0d-fb391fd054bd
Zūm Rails Testing Bank *	2a778283-d87a-4b8c-aa3e-af1ed16bc486

note

Zūm Rails Testing Bank is only available in non productive environment.

To retrieve the list of all institutions, use the List institutions API.

Configure the user interface#

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
finishredirecturl	An URL to redirect the page after the connection is completed (URL must include https://)	-	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

Configure the data to extract#

Parameter	Description	Default value	Required
gettransactions	If you want to extract transactions	false	false
getholderinformation	Mandatory when adduserinportal is true, this parameter enables to extract the account holder's name and address.	false	false
keepconnection	When true, keeps the user connection with the financial institution alive to be used for check balance and reconnect.	false	false
datefrom	By default we extract information for the last 3 months. Use this field if you want to specify another range. Format (yyyy-MM-dd)	-	false

Extra configuration#

Parameter	Description	Default value	Required
extrafield1	An extra field for custom information, later receive it when the connection is completed	-	false
extrafield2	An extra field for custom information, later receive it when the connection is completed	-	false

info

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

warning

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

List institutions#

Use this endpoint to list all supported institutions. Provide the region in the URL.

Method: GET

Endpoint: {{env}}/api/Aggregation/ListInstitutions?region=USA

{
    "statusCode": 200,
    "message": "GET Request successful.",
    "isError": false,
    "result": [
        {
            "Id": "2a778283-d87a-4b8c-aa3e-af1ed16bc486",
            "FullName": "Zūm Rails Testing Bank"
        },
        {
            "Id": "1f3a818c-d396-4ccb-af3b-d201e1c0d355",
            "FullName": "Capital One"
        },        
        {
            "Id": "67e56976-80c6-4321-b93a-969b8685c848",
            "FullName": "Bank of America"
        },
        {
            "Id": "12112c05-3eec-4987-9740-508ab3b0aa07",
            "FullName": "BMO (US)"
        },
        {
            "Id": "c48d024d-5ab4-4438-b89a-6f60c9257ed6",
            "FullName": "Charles Schwab US"
        },
        ...
    ]
}

Response

Parameter	Type	Description
Id	guid	Institution id
FullName	string	Institution full name