# Introduction Start here for Zūm Rails product guidance, operational procedures, troubleshooting, and support resources. ## Welcome to the Zūm Rails Knowledge Base Welcome to the Zūm Rails Knowledge Base — your central resource for product guidance, operational procedures, troubleshooting, and platform documentation. Whether you're onboarding a new customer, managing transactions, configuring integrations, or resolving support issues, this knowledge base is designed to help you find answers quickly and efficiently. ### What You'll Find Here The knowledge base is organized into key areas that support every stage of your Zūm Rails journey: #### Transactions & Payment Methods Learn how to create, manage, monitor, and troubleshoot payments across supported payment rails. Access guidance on transaction statuses, recurring payments, refunds, funding sources, limits, and payment methods. #### Account Settings & Administration Manage your organization’s account configuration, including team member access, webhooks, API credentials, branding, security settings, and single sign-on (SSO). #### Underwriting & Onboarding Find resources related to customer onboarding, partner onboarding, document submission, identity verification, compliance requirements, and underwriting processes. #### Invoicing, Notifications & Reporting Access information on subscriptions, invoicing workflows, notifications, reporting tools, and operational insights that help you manage your payment operations effectively. #### Troubleshooting & Support Resolve common issues, recover account access, retrieve API credentials, and learn how to contact the Zūm Rails support team when additional assistance is needed. ### How to Use This Knowledge Base Finding information is simple: 1. Use the search bar to locate articles by keyword, topic, or feature. 2. Browse categories to explore related articles and documentation. 3. Follow step-by-step guides for common operational and technical tasks. 4. Reference troubleshooting articles for known issues and resolutions. ### For Developers If you're integrating with the Zūm Rails platform, visit the developer documentation for API references, authentication guides, webhook configuration, SDK resources, and integration best practices. Zūm Rails provides both sandbox and production environments to support development and testing workflows. ### Need More Help? If you cannot find the information you're looking for, contact the Zūm Rails support team at or through the in-portal support chat. Our team is available to help with technical, operational, and account-related questions. We continuously expand and improve this knowledge base to ensure you have the resources needed to successfully operate and scale with Zūm Rails. # AGGREGATION AND INSIGHTS # Viewing aggregation information in the Portal > When a user successfully connects their bank account through data aggregation, you can access their aggregation information directly from the portal, or through the API. This article will describe how to access user aggregation information from within the portal. To view user aggregation information, follow the steps below: 1. Log in to the portal 2. On the left menu bar, click on **Users**
3. From the Users page, you can use filters to only show users connected through aggregation. Once you find the desired user, click on the 3 dots on the right, then on **Banking Information**
{% hint style="info" %} If the Banking Information selection is greyed out, the user is not connected through aggregation and therefore does not have information to display. {% endhint %} # Viewing Insights > Enabling the insights product allows you to retrieve insightful information about your users. To use insights, the following must be true: * The Insights product must be enabled on your account * The user must have successfully gone through aggregation ### Viewing Insights through the portal To view insights about a user, complete the following steps. 1. Log in to your **portal** 2. Go to **Insights > Dashboards**
3. Click on the **view insights** icon
4. Use the horizontal menu to see the available insights
# What Financial Institutions are Supported Through Aggregation? > The following financial institutions are supported through Zūm Rails aggregation: * 1st Choice Savings Credit Union * Achieva Financial * Affinity Credit Union (CA) - Business * Airline Financial Credit Union * Alterna Bank * American Express (CA) * ATB Financial * Banque Nationale du Canada (Français) * Belgian-Alliance Credit Union * BlueShore Financial * BMO - Bank of Montreal * BMO Business * Caisse Horizon CU (AB) - La Crete * Caisse Populaire Alliance * Caisse Populaire Clare * Caisse populaire Desjardins - Business * Canadian Tire Bank * Canadian Western Bank * Canadian Western Bank (Business) * Capital One Canada * Carpathia Credit Union * Casera Credit Union * CIBC * CIBC Digital Business * Coast Capital Savings * Copperfin Credit Union * Crosstown CU * Desjardins * Duca Financial Credit Union (CA) * Dundalk District Credit Union * Entegra Credit Union * Equitable Bank * First National Financial LP * First Nations Bank Of Canada * Ford Credit Canada * General Bank of Canada * Golden Horseshoe Credit Union * Home Depot Canada * Implicity Financial * Innovation Credit Union * Integris Credit Union * Island Savings Credit Union (CA) * Laurentian Bank of Canada * Libro Credit Union * Mainstreet Credit Union (CA) * Meridian - Small Business * Meridian Credit Union (Français) * Meridian Credit Union Limited * Motusbank * National Bank Business Banking * National Bank of Canada * Niverville Credit Union * Noventis Credit Union * Prospera Credit Union - Canada * RBC - Royal Bank * RBC Business * RBC Commerical * ScotiaConnect Digital Banking * Servus Credit Union (CA) * Simplii Financial * Steinbach CU * Stride Credit Union * Sun Life Financial * Sunova Credit Union * Synergy Credit Union * Tangerine * TD - Canada Trust * TD Canada Trust - Small Business * The Bank of Nova Scotia * The Windsor Family FCU * Valley Credit Union (CA) * Vancity Online Business Plus (CA) * Vancouver City Savings Credit Union * Vision Credit Union * Winnipeg Police Credit Union # Account Settings # Brand Customization You can customize email invoices, hosted/checkout pages, invoice PDFs, hosted payment profiles, and more through your Brand Customization settings. ### Customizing your brand 1. Click on **Settings > Brand Customization**
2. Use the **dropdowns** on the left side of the screen to customize your logo, colours, and footer content.
3. Click on **Save Settings** once you are happy with your changes.
You can always reset to the default settings by clicking on the reset icon next to each customization option.
### Using the customization options #### Logo The logo you upload overrides the default icon. Logos must be in JPG, JPEG, or PNG format, and less than 2Mb in size. Recommended dimensions are 90px by 90px. 1. Click on **upload**
2. Select your logo file 3. Click on **Save Settings** #### Colours Colours are represented in sections of your products and communications. You can adjust one or more of the options to represent your brand. **Brand Colour:** colour reflected on buttons, email invoices, hosted checkout, and the hosted payment profile creation. The default colour is #28c76f. **Accent Colour:** applied to links, active elements, and important text. The default colour is #28c76f. **Background Colour:** represents the colour of the background behind the frames. The default color is #f2f3f4. **Foreground Colour:** represents the colour of the frames. The default colour is #ffffff. 1. Choose which colour you want to change and click on the **coloured box** or select the field and input the HEX code.
2. You can use any of the following to change the colour. Use the arrow toggle to select your preference: * RGB * HSL * HEX 3. Click on **Save Settings** Footer Content You can customize your footer to include your phone number and email address. These details will only appear in the **email invoice** section. **Phone number:** **Email address:** email where the user can reach your customer service team. By default, it is the same email as your Zūm Portal account details page. 1. Enter the **phone number** and/or **email address** you want your users to see
2. Check the box if you want a link to display, allowing the users to manage invoices and subscriptions 3. Click **Save Settings** ### Brand customization grid You can view where each setting impacts your overall account.
# Guide to Using the API > The Zum Rails API will allow you to build a payment flow into your existing architecture in a way that you will have complete control over adding users (payees and payors) and creating transactions. An API (Application Programming Interface) is a set of rules and protocols that allows different software applications to communicate and interact with each other. It defines how requests and responses should be formatted and how data should be exchanged between applications. To integrate our API into your application, you can follow these general steps: ### **Understand the API** Start by reviewing the Zum Rails [API documentation](https://docs.zumrails.com/api-reference/overview). Understand the available endpoints, the required parameters, and the expected responses. This will give you a clear understanding of how to interact with the API. ### **Set up the Environment** Depending on the programming language or framework you're using, you may need to install any required dependencies or libraries to facilitate API integration. Make sure your development environment is properly set up. ### **Download Postman** We offer a Postman collection for you to integrate. It can be found in this section of our [API docs](https://docs.zumrails.com/api-reference/overview#postman-collection). ### **Authentication** To authenticate with the Zūm Rails API, follow these steps: 1. Log in to the Zūm Portal. 2. Navigate to **Webhook & API Settings**. 3. Under the **API Settings** section, locate your API credentials. 4. Copy your **API Username**. 5. Click **Generate Password** to create a new API password. 6. Save the generated password in a secure location.
{% hint style="info" %} **Important:** The API password is only displayed once and will not be stored in the Zūm Portal. Once you leave or refresh the page, the password cannot be retrieved. If it is lost, you will need to generate a new one. {% endhint %} You can then use the API username and password to authenticate your requests to the Zūm Rails API. ### **Understanding the Authorization Flow** Once you have your API username and password, you can get the [API base URLs and specifics](https://docs.zumrails.com/api-reference/overview#environments). To [authorize](https://docs.zumrails.com/api-reference/authentication#authenticate), set the API base URL and method. Then pass your API username and password. The endpoint to authenticate is: `POST {{env}}/api/authorize`. Once you authorize successfully, you will receive an **HTTP status code of 200** and the message **POST Request successful**.
You will also receive a bearer token, which will last up to an hour from the time it is generated, allowing multiple API calls to be made securely without authorization each time. ### **Make HTTP Requests** The Zum Rails API uses the HTTP protocol for communication. Use a library or framework in your chosen programming language to make HTTP requests to the API's endpoints. These libraries often provide convenient methods for handling HTTP methods (`GET, POST, PUT, DELETE`) and adding headers or parameters to requests. ### **Handle Responses** After sending a request to the API, you'll receive a response from the API or [webhook](https://docs.zumrails.com/api-reference/webhooks). The response will include the requested data and the result of the operation. Parse the response using the appropriate methods provided by the HTTP library to extract the relevant information from the response body. ### **Error Handling** The API will return errors in case of invalid requests or server-side issues. Implement appropriate error handling in your application to handle different HTTP status codes and error responses. This can include displaying error messages to users or retrying failed requests. ### **Test and Debug** During the integration, it's important to thoroughly test your API calls and verify that you're receiving the expected data and responses. Use tools like Postman to test the API endpoints independently before integrating them into your application. Monitor and debug any issues that may arise. ### **Implement in Your Application** Once you have successfully tested the API integration, incorporate the API calls into your application's codebase. You can encapsulate API calls in functions or classes to make them reusable and modular. Integrate the API responses into your application's logic and user interface as required. ### **Monitor and Update** After integrating the API, monitor its performance and keep an eye on any updates or changes provided by Zum Rails by subscribing to our Status [Page](https://zumrails.statuspage.io/). APIs can evolve, so make sure to update your integration accordingly and handle any deprecations or modifications. # HMAC > The key used to create the HMAC is your Webhook Secret, and you verify it by running the algorithm yourself with the payload and the key to re-create the HMAC. Your Webhook Secret can be found in the portal under your settings.
The signature is always sent with the webhook in a header named *zumrails-signature* You can verify the authenticity of the webhook response by using HMAC. The HMAC verification process is as follows: * You receive a POST request via the webhook * Your app computes a signature based on the payload received, using your Webhook Secret * You verify that your signature matches the zumrails-signature in the request **Here are the steps to validate a request coming from Zum Rails** 1. Retrieve the zumrails-signature header from the webhook:
2. Retrieve the json body of the request. Make sure you are not adding any new spaces or formats. E.g:
3. Using HMAC SHA256 implemented in your programming language, calculate the signature on your side. The body is the payload and the secret is your Webhook Secret. The output should be in Base64 format. For your tests, you can use an online [HMAC generator](https://www.liavaag.org/English/SHA-Generator/HMAC/).
4. Compare your hash with the value provided under the zumrails-signature in the request, they should match. As you can see, the Result here (hV...gys=) matches the zumrails-signature in the screenshot from step (1) above. A few [examples](https://github.com/danharper/hmac-examples) of how to calculate HMAC in different languages # How Do I Close My Account? > Before closing your account, make sure to save or download any data you would like to keep. #### Closing your account * Email **** and inform our team that you would like to close your account. Make sure that the person sending the email has the authority to make this request. * An agent will send you a letter by email confirming your request to close your account and any fees associated with the closure. * The agent will close your account and confirm that all the necessary steps have been completed. {% hint style="info" %} Accounts that have been closed cannot be reopened for compliance purposes. If you want to open an account, you will need to go through our onboarding cycle again. {% endhint %} # How Do I Setup Email Forwarding in Gmail > You can complete your email forwarding setup with Gmail by following these steps. 1. Log in to your **Gmail** account 2. Click **Settings**> **See all settings** 3. Go to **Forwarding and POP/IMAP** 4. Click **Add a forwarding address**. 5. Enter the email address where the email needs to be forwarded and click **Next.** 6. A new window will pop up and will ask you to proceed. A confirmation code may be sent to the forwarding address to confirm permission. If it's a zumrails.com address, contact [support@zumrails.com](/account-settings/how-do-i-setup-email-forwarding-in-gmail), asking to confirm the forwarding setup. 7. Navigate to **Filters and Blocked Addresses** and click on **Create filter.** #### For Alias Registration Specifically 1. For Alias Registration (auto deposit to Zūm Wallet), set up the subject as seen below. 2. Click on **Continue**, check the **Forwarding** checkbox, and choose the address where the emails should be forwarded 3. Once saved, the **Forwarding** will be created and only the emails with the keywords indicated by the filter will be sent to the forwarding address. # Managing Team Members > In this article, learn how to manage team management in the Zūm Portal. #### You can assign the following roles to a team member: **Customer Admin**: has admin access, including creating users and transactions **Customer Read-Only**: has read-only access only, but cannot edit or create **Customer Admin Support**: has admin access, but cannot create, manage, or delete team members **Customer Team Management**: has read-only access, but can create, manage, or delete team members {% hint style="info" %} *Note: all team members with an admin role will have the same level of access and will be able to manage the team.* *Note: Customer Admin and Customer Admin Support have access to the Integration Codes.* {% endhint %} ### Adding a team member Only **Customer** **Admin** and **Customer Team Management** can perform this action. The system does not accept duplicate emails. * Log in to your portal * Click on **Settings > Team > Add New Member** * Fill in the necessary details * Click on **Save**
{% hint style="info" %} Once you click **Save**, the team member will receive an email invitation to activate their account. Their username, role, and creation date will appear in the **team management** list with the status **Waiting Activation.** {% endhint %} Once the team member confirms the invitation, the status in the **team** **management** list will change to **Activated**. ### Resending an invitation If a team member did not receive their original invitation, you can always send a new one. Only **Customer Admin** and **Customer Team Management** can perform this action on team members whose status is **Waiting Activation.** * Log in to your portal * Click on **Settings > Team** * Find the name of the team member to whom you want to resend the invitation * Click the **vertical ellipsis** next to their status * Select **Resend activation e-mail**
Once completed, the team member will receive a new email invite. ### Deleting a team member Only **Customer Admin** and **Customer Team Management** can perform this action on any team member except themselves. * Log in to your portal * Click on **Settings > Team** * Find the name of the team member you want to delete * Click the three dots (**⋮**) next to their status * Select **Delete**
* A confirmation popup will appear; click **Confirm**
Once completed, the team member will be deleted from the Portal. # Single Sign-on (SSO) You can take advantage of our single sign-on (SSO) function to use your Gmail or Outlook accounts to log in with the click of a button.
This removes the need to store a username and password on your end. Simply ask [support@zumrails.com ](/account-settings/single-sign-on-sso)to enable SSO on your account and then all of your employees will be able to log into the Zum Rails portal with their secure email client. {% hint style="info" %} SSO is a global variable, meaning it will be switched on for everyone at your company. It cannot be used for just a few people. {% endhint %} # Webhooks > Webhooks are a tool that allows your organization to receive updates on the status of users and transactions. This allows you to automate your next call to action depending on the status of the payment or user. ### Enabling webhooks You can enable webhooks directly from your portal. 1. Click on **Settings > Webhook & API Settings**
2. Define your **webhook URL**
3. Use the **dropdowns** to select which **status changes** you would like to receive instant notifications for.
4. Click **Save**
You can also view your webhook secret which is used for HMAC verification. For more information, visit our article on [HMAC](https://knowledge-base.zumrails.com/hmac?hsLang=en). When your webhook URL is defined, Zūm Rails will send a POST request each time there is a status change for: * Users (only available for customers) * Transactions (only available for customers) * Customers (only available for partners) * Recurrent Transactions (only available for customers) * Subscriptions and invoices (only available for customers) * Products (only available for customers) * Shipping & Tax (only available for customers) {% hint style="info" %} If you do not have a webhook URL, you can use [webhook](http://webhook.site/).site to generate one for test purposes, until yours is active. {% endhint %} # Zūm Wallet Monthly Statements > Logging into the Zum Rails portal has never been easier or more secure! To access your monthly wallet statements, follow these steps: 1. Log in to the **Zūm Portal**. 2. From the navigation menu on the left-hand side, select **Zūm Wallet**. 3. Click **Wallet Statements**. On the **Wallet Statements** page, you will see a list of all available monthly statements. To view a statement, simply click on the month you would like to review. {% hint style="info" %} Statements are generated automatically at the beginning of each month and include all wallet transactions from the previous month. {% endhint %} If you would like to download a statement, click the corresponding download link on the right-hand side of the page. Statements can be downloaded in either **PDF** or **XLS** format.
{% hint style="info" %} PDF documents have a 500-line item limit. To view detailed statements for months with more than 500 transactions, please download using .XLS format. {% endhint %} **.PDF Statement Sample:**
**.XLS Statement Sample:**
Monthly wallet statements will be sent to the primary email connected to your Zūm Rails account by default. To receive automated monthly emails of your Zūm Wallet statements to additional email addresses, go to the **Notifications** tab and select **Monthly Wallet Statements** {% hint style="info" %} If you have any questions or concerns regarding your Zūm Wallet Statements, please reach out to us at: [support@zumrails.com](/account-settings/zum-wallet-monthly-statements) {% endhint %} # Notifications and Reporting # Accessing and Managing Reports > Zūm Rails offers you the possibility to view your data in various formats.
### Accessing your reports **Steps** 1. Log in to your **Portal** 2. Go to **Reports** 3. Select which report you want to **view**
### Report options You have 5 reporting options in your portal. Below is a brief description of each one. #### Accounts Receivable & Accounts Payable **Accounts Receivable** are the amounts that have been paid to your business. **Accounts Payable** are the amounts outgoing from your business to other users who are owed money. To select one of these options, click on the **arrow** next to their line.
The top bar represents a summary view of the number of successful transactions, average transaction amount, maximum transaction amount, and successful transaction volume.
You can see the **breakdown** of your receivables or payables in detail by reviewing each available graph: * Volume * Successful and failed transactions * Transactions by payment methods * Transaction amounts by payment method Each graph has its own date range capabilities. Simply select the date range and the dates, and the graph will auto-adjust to reflect the data.
If you want to apply the **same date range** to all the graphs, use the date range bar in the **upper right corner** above the summary line.
Once you have selected your date range you can also filter by **available payment method.** Simply select the payment method you want to view or select **all** if you want to view them simultaneously.
#### Invoices & Subscriptions In this section, you can view: * Total revenue earned by payment method * Active Subscriptions * New Subscriptions * Outstanding Invoices * Revenue from products * Average Revenue * Top Users * Subscription Churn Rate * Churned Revenue Each graph has its own date range capabilities. Simply select the date range and the dates and the graph will auto-adjust to reflect the data.
If you want to apply the **same date range** to all the graphs, use the date range bar in the **upper right corner** above the summary line.
#### Last Day Reports Last day reports allow you to view the **summary** of previous transactions in one of the following statuses: * Completed * Failed * Cancelled * Created at You can **filter** the report by **payment method** and **date** by using the filters at the top of the page.
You can also **download** your report by clicking on the download icon in the upper right corner
#### Failure Reports Failure reports allow you to view the transactions that have failed in the following formats: * Transaction failures by payment methods * Transaction failures detailed summary You can filter by **payment method** and by **date** by using the filters available in each graph. ### Downloading reports On each reporting page, you have the option to download certain reports in .xlsx format. To download your report, look for the download button on![](/files/rjuC0n0kmzmeS3JqS1qR)your **graph**. ### Toggling between reports If you want to go from one report to another easily, use the tab system at the top of the page and click on the report you want to view.
# Email Notification of Failed Webhooks > You can be notified via email when a webhook fails to send. This can be set up in the portal, by following these steps: Log in to the Portal and click on the **Settings** tab Once in **Settings**, click on **Notifications**
Then click on **Create New Notification**
Enter the email addresses you'd like to have notified and select **Webhook Failure** under the notification type. Click **Save**. # Holiday Schedule > Holidays play a key role in determining when money can be moved. The delay only affects bank-to-bank transfers (EFTs) and settlements. The ability to process Interac, VisaDirect, and CC remains unchanged, but any AR funds that are batched and deposited into a merchant account will occur the next business day. You are still able to submit EFT transactions within your Zūm environment on a holiday, the transactions will be added to a queue to be sent to the bank at the next file transfer time, which will be in the morning of the next business day. Please reference the holiday schedule from the [Bank of Canada](https://www.bankofcanada.ca/press/upcoming-events/bank-of-canada-holiday-schedule/) # Negative Wallet Overview > ### What is a negative wallet? A negative wallet is when your Zūm wallet, which is used to facilitate the transfer of funds, falls below $0. This is similar to a cash advance from Zūm, and the negative balance must be rectified, as money will be unable to be dispatched to end users from the wallet, and penalties can occur. ### What causes the wallet to go negative? A negative wallet balance is generally caused by EFT failures known as late failures. These are transactions that were originally deemed successful but were later changed to unsuccessful by either the sending or receiving financial institution. More information on late failures can be found[ here](/transactions-and-payment-methods/late-failures). ### Understanding the wallet To better understand your wallet and the transactions, you can view it from your Zūm portal under the **Zūm Wallet** section. Here you can see all transactions, the amount of funds in transit through the wallet, and the total remaining balance. This report can be exported for ease of use. The transaction **description** details what happened to the transaction. You can use the **transaction link** to see the history of what happened to the funds. ### How do I resolve a negative wallet? In some instances, funds that ended up reaching their destination were not accounted for or clawed back by the sending financial institution. These funds will either need to be taken back from the receiving user or reclaimed from the sending user and sent to the wallet. To do this, you will need to create a transaction from the user you wish to recover the funds from either with the portal or using the API. Information on transaction creation for the portal can be found [here.](/notifications-and-reporting/negative-wallet-overview) {% hint style="info" %} NOTE: If the negative balance in your Zūm wallet isn’t rectified within 24 hours, this may result in penalties on your next monthly bill. {% endhint %} # Receiving Email Notifications of Transaction Events and Daily Reports > The Notifications feature allows any email address entered to receive notifications of transaction statuses or previous daily reports. Emails regarding transaction failures are sent out every hour, while emails with the previous daily report are sent out every morning. You can add email addresses and specify what kind of notifications you’d like to be sent. ### Creating a notification 1. Go to **Settings** on the left menu bar 2. Click on the **Notifications** tab 3. Click on **Create New Notification** in the top right corner 4. There will be 3-4 fields to complete * **Email address** (as many as you’d like) * **Type** * Transactions Failure * Last day report * **Transaction Method** * EFT * VisaDirect * CreditCard * Interac * **Transaction Event** (select all that apply) 5. Click **Add**
If you want to delete an email from getting notifications, you can delete it by clicking on the three dots, then click on **Delete**
The notifications feature also allows you to create different lists. For example, you can set email: , to receive emails when there is a specific error (transaction event) and set email: to receive emails for a different error (transaction event). # Invoicing and Subscriptions # Adding a Product > Products are essential to invoices and subscriptions. Below you can review how to add these through your Zūm Portal or the API. {% embed url="" %} ### Through your Zūm Portal 1. Log in to your **portal** 2. Go to **Products > Overview > Add new**
3. Fill in the **name, description,** and **image** if there is one
4. Fill in **Price Information**
5\. Click **Create product** 6. Click **Confirm** You will be redirected to the overview page where you can view your newly created product and all other products. # Adding Pricing To Products > To add pricing to a product, you must first create a product. Once you have created your product, you can then select how to price it. Below your product section, you will see a section called **price information**. **Steps** 1. Select your **pricing model**
2. Select your **price**. If you have chosen a **package** as your pricing model, you will also need to choose your unit number
3. Select your **frequency**
If you choose your frequency as a **Recurring plan** you will need the following information: * Name * Description * Billing Period 4. Click **Create product**
### Adding additional prices You can add multiple prices to one product. If you want to create many prices under one product, click on **Add another price** under the image icon and repeat the above steps. # Creating a Subscription > Subscriptions are an essential part of any active business. Zūm Rails has simplified how to create a subscription through the Zūm Portal, the API, and embedded codes. {% embed url="" %} ### Through your Zūm portal 1. Log in to your **portal** 2. Click **Subscriptions > Add new**
3. Input all the **information** for the subscription
4. Select the **Payment Method**. You can do so by using one of the following: 1. Automatically select **payment** and then select the **payment method**. Payment methods will vary depending on the selected user.
2. Manually by selecting **email invoice to the user to pay manually**. This will prompt you to select how many days the payment is due and by which method.
Click **Start subscription** # Creating an Invoice > You can create an invoice using your Zūm Portal or the API. {% embed url="" %} ### Creating an invoice through your Zūm portal To create an invoice follow the below steps. **Steps** 1. Log in to your **Portal** 2. Select **Invoices > Add new**
3. Fill in the information required for **each field**
4. Select how you would like to collect the payment from your user. You can do so by using one of the following methods: Select **payment** and then select the **payment method**. Payment methods will vary depending on the selected user.
Manually by selecting **email invoice to the user to pay manually**.
This will prompt you to select how many days the payment is due and by which method. Once you're done completing the information for your invoice, you can preview the invoice details on the right before finalizing. 5. You can either save it as a **draft** and finalize your invoice at a later date, **cancel** the invoice, or click **Create Invoice** to finalize your selection. # Disabling outgoing emails for Invoices and Subscriptions > If you utilize the invoices or subscriptions feature you can now disable the function that sends outgoing emails after these transactions are created. This will allow you to deploy your own template and will prevent our system from sending out additional emails to your users. You can enable this feature by going to the **Settings >> Invoice Settings** section of your Zūm portal.
To stop invoice and subscription emails from being sent, simply activate the **Disable all emails for invoices and subscriptions** setting. This setting is disabled by default. Once activated, the Zūm system will no longer automatically send email notifications related to invoices and subscriptions.
{% hint style="info" %} If you would like to re-enable this feature in the future, simply change the setting back to **Activated**. Once re-enabled, email notifications will automatically be sent for all invoice- and subscription-related transactions. {% endhint %} # How Do I Price My Products? #### What is a price? A price is the amount of money you charge for your product or service. When you create a product, you must add pricing information. Prices are attributed a frequency. You can price your product or service by selecting one of the following: * One time * Recurring plan #### What price frequency should I choose? Your price frequency depends on the type of product you create. * If you create a stand-alone product, choose **one time**. * If you have a product or service that requires a subscription model, choose a **recurring plan**. By choosing a **recurring plan,** you can set the price and the billing period in which your customer gets charged. You can choose from the following: * Weekly * Biweekly * Monthly * Annually If you sell the same product at different subscription intervals, we recommend creating multiple recurring prices for the same product. Because a product can have multiple prices associated with it, you’ll need to select which price to use when creating checkout links, invoices, or subscriptions if you want to sell a specific product price to the customer. **You must always select at least one price when creating a product** #### How do I select my pricing model? Pricing models reflect your business revenue model. Zūm Rails offers 2 pricing models: * **Standard** **pricing**: This means you charge the same price for each unit every time * **Package pricing:** This means you charge by package (group of units) {% hint style="info" %} Package pricing is automatically rounded up. This means, for example, if you charge $15.00 CAD for every 5 units purchased, a customer who purchases 8 units will pay $30.00 CAD. {% endhint %} # Managing Your Invoices > You can manage your invoices through your Zūm portal or the API. This is an easy to see all your invoices in one place. In this document, we review: ### Viewing your invoices #### Through your Zūm portal You can view all your invoices in one place in your Zūm portal. **Steps** 1. Log in to your **portal** 2. Select **Invoices** Here you can see all the invoices. You can use the search bar or the tile options to search for a specific invoice.
3. Once you have located the invoice you want to view, click on the **three dots (⋮)** and select **Details**.
Here you view payment method, status, and product details.
### Editing your invoice #### Through your Zūm portal 1. Log in to your **portal** 2. Select **Invoices** 3. Once you have located the invoice you want to view, click on the **three dots (⋮)** and select **Edit**. You can only edit invoices that have the status **Draft**.
Once you have completed your changes, click **Create Invoice**. ### Managing your invoice status #### Through your Zūm portal You can modify an invoice status to reflect its current status. **Steps** 1. Log in to your **portal** 2. Select **Invoices** 3. Locate the invoice you want to adjust, click the **three dots (⋮)** at the end of the invoice line, and click **Details**
4. Select **Modify invoice status**
5. Select which **status** you want to attribute to the invoice
6. Enter your **portal login password and click Confirm.** # Managing Your Subscriptions > You can manage your subscriptions through your Zūm portal or the API. This is an easy way to see all your subscriptions in one place. {% embed url="" %} ### Viewing your subscriptions #### Through your Zūm portal You can view all your subscriptions in one place in your Zūm portal. **Steps** 1. Log in to your **portal** 2. Select **Subscriptions**. *Here you can see all of your subscriptions. You can use the search bar or the tile options to search for a specific subscription.*
3. Once you have located the subscription you want to view, click on the **three dots (⋮)** and select **Details**. *Here you view payment method and user details, upcoming invoices, and product details.*
### Editing a subscription #### Through your Zūm portal **Steps** 1. Log in to your **portal** 2. Select **Subscriptions**. Find the subscription you want to edit 3. Once you have located the subscription you want to edit, click on the **three dots (⋮)** and select **Edit**.
4. Make all the **changes** needed 5. Click **Update Subscription** ### Canceling a subscription #### Through your Zūm portal **Steps** 1. Log in to your **portal** 2. Select **Subscriptions**. Find the subscription you want to cancel. 3. Once you have located the subscription you want to cancel click on the **three dots (⋮)** and select **cancel**.
4. Fill in all the **fields**
5. Click **Confirm Cancellation** 6. Enter your portal **password** 7. Click **confirm** # Shipping Rates ### What is a shipping rate? Shipping rates describe the price of shipping presented to your customers. It can be applied to invoices, subscriptions, or checkout links to collect shipping costs. {% hint style="info" %} Zūm Rails does **not** automatically set them on your behalf unless you specifically set it when creating the shipping rate. {% endhint %} ### Creating a shipping rate 1. Log in to your **portal** 2. Click **Products > Shipping** 3. Click **Add new shipping rate** 4. Fill in the **fields**
5. Click **Save**. You will be redirected to your main page where you can view all created shipping rates
#### Field definitions | Amount | the dollar value of the shipping rate | | ----------------------- | ------------------------------------------ | | Description | what the customer sees on their invoice | | Estimated shipping time | the time it takes to receive the product\* | {% hint style="info" %} If you leave this field blank no shipping time will appear on the customer invoice {% endhint %} ### Editing a shipping rate 1. Go to your shipping rates **main page** where you can view all your created rates 2. Select which shipping rate you want to edit by clicking on the ellipsis
3. Click **Edit** 4. Make any changes necessary 5. Click **Save** ### Archiving a shipping rate 1. Go to your shipping rates **main page** where you can view all your created rates 2. Select which shipping rate you want to edit by clicking on the **ellipsis**
3. Click **Archive** 4. Click **Confirm**. The status of your shipping rate will change from active to archived ### Unarchiving a shipping rate 1. Go to your shipping rates **main page** where you can view all your created rates 2. Select which shipping rate you want to edit by clicking on the **ellipsis**
3. Click **Unarchive** 4. Click **Confirm**. The status of your shipping rate will change from archived to active # Tax Rates > You can create and save multiple tax rates and apply them to invoices, subscriptions, and payments whenever you use checkout. {% hint style="info" %} Tax rates are not automatically set when creating products, invoices, or subscriptions and must be set when you create your tax rate. {% endhint %} ### Creating a tax rate in the portal 1. Log in to your P**ortal** 2. Click **Products > Tax Rates** 3. Click **Add new tax rate**
4. Fill out all the **fields**
5. Click **Save.** You will be redirected to the home page where you can view all created tax rates
#### Field definitions | Tax type | This is the display name of the tax that will appear on the customer invoice, checkout, and hosted page. You can select from GST, HST, PST, Custom\* | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Description | The description is for internal use only and will not be visible to the customer | | Rate | the % of tax applied | | Exclusive vs. Inclusive | The tax is included or excluded in the invoice subtotal | | Province | If a particular region is selected and the checkbox to automatically add the tax to invoices is checked, Zūm Rails will add the rate to the customer invoice/subscription by their billing/shipping address | {% hint style="info" %} If you select custom, you must add a description {% endhint %} **Exclusive vs. Inclusive** The following table illustrates a 13% tax rate modifying the total amount due, depending on whether it’s exclusive or inclusive. | Tax | Subtotal | Tax Due | Total | | ------------- | -------- | ------------------------------------- | --------------------- | | 13% Exclusive | $5.00 | $0.65 | $5.65 ($5.00 + $0.65) | | 13% Inclusive | $5.00 | $0.65 (already included in the price) | $5.00 ($4.35 + $0.65) | When determining tax amounts, Zūm Rails rounds to the smallest currency unit (2 decimals) before summing across the entire invoice. You can add multiple tax rates to invoices/subscriptions or for checkout links. # Viewing Past Invoices > You can get a history of your invoices from the emails that are sent out for each billing period. In the email, you will see a link to manage your invoices and subscriptions. Follow the steps in the link to get access to the user portal, where you can find each monthly invoice that was previously sent for your environment.
# What Is a Product? > A product represents a good or service offered to your customers. Each product has a unique ID which is automatically generated when it is created. When you create a product in Zūm Rails, you must provide a name. You can optionally add other attributes, like a description or image.
### Can I have multiple products? Yes. However, if you have multiple products, you will need to specify which product to use when creating checkout links, invoices, or subscriptions to sell a specific product to your customer For information on how to price your products, take a look at our [pricing article.](/invoicing-and-subscriptions/how-do-i-price-my-products) # Transactions and Payment Methods # Accessing Transaction Limits > You can check your Zūm Rails processing limits from within your environment at any time. Simply follow these steps: 1. Log in to your Zūm Rails portal 2. On the left menu bar, go to **Settings** 3. Once in the Settings menu, please select **Payment Methods**
4. In the Payment Methods section, you will be able to look at each payment method you have available. You can expand this by clicking on the triangle on the right side
5. In each payment method tab, you will see a section called **Transaction Limits** ### Checking Limits as a Partner If you are a partner, you can check your customers' limits by following similar steps; however, you first have to locate the customer and look at their settings specifically. 1. Go to your **Customer** section 2. Once you have located the customer, click on the three dots on the right
3. Then click **Edit**, followed by **Payment Methods** 4. In the Payment Methods section, you will be able to look at each payment method you have available. You can expand this by clicking on the triangle on the right side
5. In each payment method tab, you will see a section called **Transaction Limits** # Adding a Funding Source > A funding source is your business bank account. You can have more than one funding source to push funds to or pull funds from. You can settle transactions directly to your funding source, or settle them in the Zūm wallet and direct them to the funding source in one bulk transaction. Adding a funding source is the first step you need to complete when logging in for the first time. For production accounts, this is also required as part of the underwriting process. If you are adding a funding source specifically for a production account, it must be a **business account.** 1. Click on **Funding Source > Add new bank account**
2. Select your **account type** and complete **all fields.**
3. Click on **Next** 4. Click on **Agree** after reading the consent section
5\. Select your **banking institution**
6. Enter your **banking credentials.** By completing this step, you allow Zūm Rails to connect to your selected bank account and retrieve your financial data.
All available accounts will appear once the user has entered their credentials. Note that no credentials are ever stored when entered. * The user must select if they want to connect a savings or chequing account and select continue * The user is redirected. Collecting their banking information occurs in the background and can take up to 3 minutes. If you are connecting through a sandbox and are using the Zūm Rails Test Bank, the credentials are listed at the bottom of the page under the **submit** button. *** ### I can't connect my funding source If you cannot connect your funding source through the aggregation process please complete the following steps. * Take a screenshot of the error message * Email [support@zumrails.com](/transactions-and-payment-methods/adding-a-funding-source) and include the screenshot and the financial institution you are attempting to connect * Upload the following documents through your portal: * A void cheque * 2 months of your most recent transaction history If you are not sure how to upload documents in your portal you can follow the steps in the article [Adding Documents to the Portal.](/transactions-and-payment-methods/adding-a-funding-source) # Can I Edit a Recurrent Transaction? > You can edit a recurrent transaction by first locating the desired recurrent transaction. To do so, Click on **Recurrent Transactions** on the left menu bar in your portal. Once located, you can select “Edit” by clicking on the three dots on the far right.
You can only edit specific fields. Those include: * Amount ($) * Start Date * End Date * Day of the week/month the transaction will be executed on After completing the desired modifications, you can select whether you want to **revert** the modifications after the next transaction or **keep** the modifications for all transactions moving forward. By default, modifications are not reverted after the next transaction. If you want to revert them moving forward, simply check the box. Click **Save** to complete the process. # Canceling a Transaction > You can cancel a transaction through your portal. However, the timeframe to cancel a transaction is limited and varies by payment method. {% embed url="" %} 1. Log in to your **portal** 2. Click on **Transactions**
3. Locate the transaction by using the **search bar**
4. Click on the **vertical ellipsis** next to the transaction
5. Click **Cancel** 6. Click **Confirm** If you cannot cancel the transaction, it is too late; the file has already been sent to the bank. In this case, you will need to reverse the transaction by creating an inverse transaction. **Example:** If the transaction you'd like to reverse is an account payable transaction from the Wallet to a UserA, to reverse it, you will need to create an account receivable transaction from your UserA to the Wallet with the same amount. # Creating a Recurrent Transaction > You can set up recurrent transactions through your portal or the API based on dates or the number of transactions. {% embed url="" %} #### Through the portal 1. Log in to your **portal** 2. Select **Transactions > Add new**
3. Fill in all the **fields**
4. Click **Recurrent transaction**
5. Select if you want to calculate your recurrent transaction by **end date** or by **transactions** If you select **recurrent type - monthly** you cannot select any date after the 28th of any given month. This is because not every month has the same number of days. # Creating a Scheduled Transaction > You can set up a scheduled transaction through your portal or the API. By completing these steps you will enable a one time transaction to occur on a selected date in the future. {% embed url="" %} #### Through the portal 1. Log in to your **portal** 2. Select **Transactions > Add new**
3. Fill in all the **fields**
4. Click **Delay transaction initiation**
5. Select your **scheduled start date** 6. Click **save** # Creating a Transaction ### You can create a transaction through your portal or the API. {% embed url="" %} ### Through the portal 1. Log in to your **portal** 2. Select **Transactions > Add new**
3. Fill in all the **fields**
* **Transaction Type** * **Fund Zūm Wallet**\ `FundingSource → Zūm Wallet` * **Withdraw Zūm Wallet**\ `Zūm Wallet → FundingSource` * **Accounts Payable**\ `FundingSource/Zūm Wallet → User` * **Accounts Receivable**\ `User → FundingSource/Zūm Wallet` * **Transaction method** 1. EFT 2. Interac 3. VisaDirect 4. CreditCard * **From:** (Originating account) * **To:** (Destination account) * **Amount** ($) * **Memo** (optional; up to 15 characters) * **Comment** (optional) * **Security Question and Answer** (Optional: If Auto-deposit not available) * Click **Save** ### Through the API For instructions on our to create transactions utilizing the API please refer to our [documentation](https://docs.zumrails.com/api-reference/transactions). # Credit Card Refund Process > To perform a credit card refund you will need the original transaction ID which you want to refund. It is possible to do partial refunds. You can only refund an Accounts Receivable credit card transaction after it has been completed. You can do this through the API or the Portal. ### **Credit Card Refund through API:** Considering you performed an Accounts Receivable Credit Card transaction which was successful and received a transaction ID (highlighted in yellow) in the response. Until the transaction succeeds, the **IsRefundable** flag will be False: Transaction creation `API (POST): {{env}}/api/transaction` **Accounts Receivable Credit Card Request:**
**Accounts Receivable Credit Card Response:**
Once the original transaction has settled, you can process refund for this transaction. (Note: Refunds can be processed anytime after the original transaction has been settled). Performing a refund for the above transaction: **Credit Card Refund `API (POST): {{env}}/api/transaction/{transaction_id}/Refund`** In the payload you will specify the amount: `{` `""Amount"": 9.99,` `}` If the amount you specify is less than the original transaction amount, it will be a partial refund. **Credit Card Refund response:**
### **Credit Card Refund through the Portal:** Create an AR Credit Card transaction like this:
Once we create the transaction, it can be viewed in the transaction list. Once the transaction is completed, click on the vertical ellipses to see the option for “Refund”. Click on refund:
When you click on refund, you will see a pop-up which will ask you to confirm the refund:
Once confirmed, you will see the refund transaction in the transactions list:
You can see the transaction ID of the original transaction in the “details” page of the refund transaction:
**Settlement Timeline:** The settlement timeline for refunds is the same as for Credit Purchases. Refunds are processed in real time and will be settled into the users’ account on the next day or within the standard three-day funding timeline. # Definitions When Creating a Transaction **From:** The starting place of the funds. **To:** Destination to receive funds. **Amount:** $ value in Canadian dollars (CAD). **Memo:** Memo that appears on the bank statement. *(If Transaction Description is set as ""Per transaction"" in your settings. If the Transaction Description is ""Fixed"", this will not display on the bank statement.)* **Comment:** An internal comment for EFT, Visa Direct, and Credit Cards. For Interac, whatever is entered as a comment will be displayed in the Interac email. # How to withdraw sum total for batch payables > Zūm Rails has introduced a functionality for batch account payables from the funding source to the user. This is where you, the customer, can pull the sum total of payables from the funding source to your wallet, and then send the money to your individual users in the batch from the wallet. To access this functionality using the portal, follow the steps below: 1. Navigate to the upload batch file option > choose transaction type **Accounts Payable** and withdraw funds from a funding source (choose your EFT funding source). Once completed, you will see the checkbox at the bottom which states **withdraw funds from funding source for sum total**, select that checkbox.
2. Next, upload the CSV file and click on **validate**. Once completed, **Process** the batch. 3. Once the batch is successfully processed, you will see one transaction from your funding source to your wallet, and this transaction will pull the sum total of your payables.
4. Once this transaction is successful, Zūm will complete the remaining transactions from the wallet to pay the users in the batch payable CSV in sequence. To access this functionality using the **API**, provide the parameter: **`WithdrawSumTotalFromFundingSource=True`** in while using this Endpoint:`{{env}}/api/transaction/ProcessBatchFile` **NOTE:** This feature does not work for scheduled batch payables or batch payables with only one payment. For any questions, please reach out through the chat function in the portal or email us at # Instant Transaction Status Updates For Interac Account Receivable Transactions > Depending on your Interac configuration, Interac accounts receivable transactions can have a delay in updating the transaction status to completed. Customers can get **instant** transaction status updates for Interac account receivable transactions by enabling the email notifications feature. ### Enabling email notifications 1. Log in to your **Zūm Portal** 2. Click **Settings > Payment Methods > Interac** 3. Check the box **Receive confirmation email for Accounts Receivable transactions**
4. Click **Save** to confirm changes Once these steps have been completed, you will start receiving confirmation emails every time a user completes an Interac request. The confirmation email will be sent to the one listed in “**Email to be displayed on the Interac request**” in the portal.
If you use an email address from your organization to be displayed, you will need to enable email forwarding to: [interac-confirmations@zumrails.com ](/transactions-and-payment-methods/instant-transaction-status-updates-for-interac-account-receivable-transactions). If email forwarding is not set up properly, the transaction will not update automatically, and it will be subject to regular delay. If you would prefer to avoid email forwarding, you can utilize this feature by specifying: **** in the field “**Email to be displayed on the Interac request**”. Please reach out to [support@zumrails.com ](/transactions-and-payment-methods/instant-transaction-status-updates-for-interac-account-receivable-transactions)if you have any questions. # Interac Alias Registration > Interac Alias Registration customers can receive funds from their users into their Zūm Rails wallet conveniently and securely. The user initiates the transfer of funds using their online banking account and sends the funds directly to the customer’s email address. The transfer will be automatically posted in the Zūm Rails system. Once the e-transfer reaches the designated email address, customers will be able to see the transaction and the related user in the Zūm Rails dashboard. ### Setting up your Interac Alias Registration There are two options you can choose from for your Interac Alias Registration setup. Contact Zūm Rails at [support@zumrails.com ](/transactions-and-payment-methods/interac-alias-registration)to help enable the Alias Registration feature. Choose between the following options: **Option 1:** Zūm Rails will create an email address for you and manage it entirely on our side. Your users will be able to use this email address to send e-transfers to and they will be deposited directly into your Zūm Wallet. This email address will be: [YourBusinessName@automaticdeposits.com](/transactions-and-payment-methods/interac-alias-registration) There is a small set-up fee for this and is done on our side with no action required on your part. **Option 2:** If you’d like to use an email address from your organization, you will need to enable email forwarding in order to re-direct the Interac emails to . If you request to register an email address from your organization, you will be required to complete the registration with our Integration team during a meeting. During the meeting, you will receive an email with the subject line “INTERAC e-Transfer: Verify your registration for Autodeposit”. You will have to verify and complete the registration to be able to receive auto-deposits to the email address. You will then be required to set up email forwarding to and complete a test transaction. Once signed off by our integration team that everything functions as expected, this feature will be available to use! Please note that when using your organization's email, if email forwarding is not enabled or is not working, no transaction will be created in the Zūm Wallet/portal. Please note, if you’d like to remove your auto-deposit registration, you need to contact us at [support@zumrails.com](/transactions-and-payment-methods/interac-alias-registration) # Interac ANR > Zūm Rails allows you to send money directly into the users' accounts using Interac. With ANR, when money is sent via Interac, it is automatically deposited into the user's account with no intervention. All you need is the user's bank account information when creating a transaction. ### Using Interac ANR When creating a new transaction for a user whose bank account information is available, you must select the checkbox **Deposit funds directly into the user's bank account**. Once completed, the funds will be deposited directly into the end user's bank account. The transaction must be an Interac Accounts Payable from Wallet to User
If the user's bank account information is not available when you create the transaction, you will not be able to see the checkbox. #### Institutions that support Interac ANR * CIBC (010) * BMO (001) * RBC (003) * TD (004) * Bank of Nova Scotia (002) * National Bank of Canada (006) * Canadian Imperial Bank of Commerce (010) * HSBC Bank Canada (016) * Alberta Treasury Branches (219) * Motus Bank (374) * Coast Capital Savings Federal Credit Union (809) * Peoples Trust Company (621) * Central 1 Credit Union British Columbia (809) * Van City (809) * First West Credit Union (809) * La Caisse Centrale Desjardins Du Québec (815) * Central 1 Credit Union Ontario (828) * Meridian Credit Union (837) The system checks are based on the institution number/bank code. If the institution bank has the same code but another name, it will be enabled for ANR. There is an extra charge to use this feature. For pricing please contact sales at [sales@zumrails.com](/transactions-and-payment-methods/interac-anr) # Interac Fraud Prevention - Name Matching > As the threat of fraud continues to be present in the payments space, Interac is constantly working to improve their fraud alert processes. Zūm Rails regularly reviews these improvements to incorporate them into our platform and discourage fraudulent transactions. As a result, we have added the error code **InteracFailedNameMismatch**. This code appears when an account holder's name used to fulfill the Interac request and the name of the user who created the transaction are different.
Our name matching tool makes this possible while still allowing legitimate users with only minor differences in their names to pass transactions. If a name mismatch is detected, you can be notified via a webhook and/or email. In the portal, you can check the name used to fulfill the request as well as the name of the user, as pictured below. If the name does not match, the transaction will fail automatically. If the transaction does fail due to **InteracFailedNameMismatch**, you will need to update your user's name before attempting another transaction. Not all financial institutions provide the debtor name to Interac. As a result, some transactions might still complete, and the Interac debtor full name may not be available. # Interac transaction in Review > Interac sometimes flags certain transactions that they believe could be possible fraud cases. When that is communicated to us, we change the status of such transactions to **In Review**. To process this transaction further and allow you to investigate and take appropriate action, we have created functionality within the portal. Here is how you can advise on how to treat such transactions: **Step 1:** Right-click on the vertical ellipses next to the transactions which have the status **In Review**. Click on **Take action**
**Step 2:** Use the pop-up that opens to decide how you want to proceed with this transaction. Hover over each radio option to see how the transaction will be treated further on each of the actions.
**Step 3:** Once you choose an option and confirm your action, it will ask you for your portal password. Once done, it will send an email to Interac confirming the action taken, and the transaction will be further updated based on the action taken. NOTE: This feature is only available for portal users with Admin roles. Also, this feature only applies to certain accounts. When you select an option, the following behaviour will occur: **Confirmed Legitimate:** The transaction will be reviewed by the bank and will complete **Presumed Legitimate:** The transaction will be reviewed by the bank and will complete **Confirmed Fraud:** The transaction will be reviewed by the bank and will fail **Scam:** The transaction will fail, and the user will be added to a banned accounts list **Please note**: Because each transaction is reviewed manually by the bank, a transaction might be under review for up to 7 days; after that, our system will automatically cancel it. # Interac Transaction Stuck in Progress > There are infrequent cases where an Interac transaction will read **In Progress** after the expiry date. These happen when the bank holds the transaction for analysis or review. These transactions will not complete, and the status will eventually be changed to Cancelled. You will need to create a new Interac transaction if you want to try again. # Late Failures > A late failure means a transaction was successful and the money moved but later failed. This happens because banks and banking clients have a window of time where they can revert transactions or correct the completed status. Most failures happen within three business days. However, it is possible that certain timeframes extend beyond this. When a late failure occurs, you will notice the money move to its destination but come back days later. To understand why this happens review the transaction history to understand the source of the failure and take corrective action. You can find a list of possible errors and their brief descriptions by choosing a payment method on our [documentation page](/transactions-and-payment-methods/late-failures). # The transactions for a user keep failing but shouldn’t > There are certain scenarios where the bank will fail transactions from a user (customer) even if they have enough funds in their account. In these cases, the transactions will continue to fail until you reach out to our support team. If a transaction fails and you contact the user who confirms they had the funds, please contact us with the user’s name or transaction\_id. You need to have written proof that the user wants to continue making payments (e.g. an email confirmation) In the case of NSFs, this works a bit differently. If there have been 2 transaction failures caused by insufficient funds in the span of 30 days, there is a block put on a user's account number so transactions cannot be completed until 30 days have passed since the occurrence of the first NSF. This is unfortunately out of our control and is a process put in place by Payments Canada to mitigate potential risks that all processor banks have to abide by. More information can be found in the Payments Canada guidelines located at: # The Zūm Wallet > The Zūm Wallet is a virtual account used to move money from your bank account to your user's bank or from their bank account to yours. Every Zūm Rails account comes with one Zūm Wallet. {% embed url="" %} ### ### Is the Zūm wallet right for my business? During your integration, we recommend discussing the option of having a Zūm wallet and its benefits for your business. ### Can I have multiple Zūm wallets? No. Each account comes with one Zūm wallet. ### What payment methods go through the Zūm wallet? All payment methods go through the Zūm wallet except Credit Card. Credit Card payments get deposited directly into the merchant account. ### What are the benefits of using the Zūm wallet? Your business is unique, and your assigned Integration Specialist is best suited to tell you all the benefits specific to your industry. However, a few common benefits are: * The ability to collect funds from multiple users and only make one disbursement and vice versa * The ability to prefund the wallet, allowing you to increase your transaction speed # Transaction Filtering > You can use the transactions section in your portal to filter and view transactions based on available data. Here is how to access and use this tab. ### Filtering transactions 1. Log in to your **portal** 2. Click \*\*Transactions \*\*in the menu 3. You can use any of the **below** to filter for the desired data #### Filtering using the search bar 1. Click on the **""+"" sign** and select all the filters you want to apply to your search
Once you select the **parameter(s)** it will appear below the search bar
Use the drop-down next to **entries** to choose how many transactions you want to view per page.
The portal has a 30-day filter applied by default. If you want to adjust this date range, you will first need to remove this filter and then apply the date range of your choice. #### #### Filtering using transaction statuses You can use the **tabs** below the search bar to filter for transactions based on their status.
#### Filter options and definitions: | \*\*Category\*\* | \*\*Definition\*\* | | ------------------------ | ------------------------------------------------------------------------------------------ | | Date | The date range you want to apply as your filter | | Transaction type | The type of transaction you want to view (Refund, Accounts Payable, Wallet Transfer, etc.) | | Transaction Method | EFT, Interac, Visa Direct, or Credit Card | | Transaction status | The transactions status you want to view (Completed, Failed, Scheduled, etc.) | | Fraud alert action taken | If an action was take on an alert that was triggered by a transaction | | Fraud alert reported | If a transaction triggered a fraud alert | | Failed Event | An event that did not complete successfully | | User name | Name of user | | User ID | Alphanumeric sequence corresponding to a unique user | | Invoice ID | Alphanumeric sequence corresponding to a unique invoice | | Subscription ID | Alphanumeric sequence corresponding to a unique subscription | | Batch number | Number of the batch containing the transaction | | Memo | A predetermined note that appears next to a transaction | | Client Transaction ID | Alphanumeric sequence corresponding to a unique transaction | If you are a **partner,** you can see all your customers' transactions in a summary format, or you can filter down to view one customer's information at a time ### Exporting data You can export your transactions by clicking on **Export to .xls**
# Transaction Frequencies > Transaction frequencies allow you to setup how often you would like a specific transaction to occur. Zūm Rails offers 3 types of transaction frequencies: ### Single A one-time transaction is when you create a transaction in your portal to occur only once. It will trigger once you click save, and the entirety of the transaction will happen in real time. ### Recurrent A recurrent transaction is set by start date and end date, or by a number of transactions. There is a fixed number of times that it can occur, and then it automatically stops. There are limitations when selecting a recurrent transaction date to ensure there are no failures due to the uneven days in the months. ### Scheduled A scheduled transaction is a one-time transaction that is set to occur at a later date. Once the transaction has occurred and the date has passed, it will not happen again. # Transaction Times > The following article discusses the transaction time associated with the following payment methods: ### Interac By using Interac, the money transfers when the user completes the designated Interac flow. There are 2 options for Interac. #### Option 1 (Default) With option 1, when a person initiates a transaction, the end-user will receive an email directly from Interac, requesting to complete the transaction. This can be an Accounts Payable or an Accounts Receivable transaction. With this option, there may be up to a 4-hour delay for the bank to update the user’s bank statement and to confirm the transaction in the Zūm Rails system. **Interac Process** * Create a transaction and specify the Interac transaction method * An email is triggered and sent to the end user from Interac * The end user follows the steps received in the email The funds will be transferred as soon as both Interac and the bank process the transaction, which may result in a delay for the Zūm system to confirm the transaction's success. Once the transaction is completed, the funds will settle in the Zūm wallet. ### Option 2 With option 2, for accounts receivable, you have the choice to send the Interac email directly to your user (same as option 1), or you can display the Interac UI in a different tab right away. Option 2 also allows you to customize what is displayed in the user’s bank statement. In this flow, you will get an instant notification or a successful status as soon as the user completes the Interac portion, but the funds are subject to a settlement schedule. Please contact [support@zumrails.com](/transactions-and-payment-methods/transaction-times) for more details. When doing an accounts payable transaction, the flow is the same in both options. **Interac Process** * Create a transaction and specify the Interac transaction method * An email is triggered and sent to the end user from Interac OR opened in a new tab depending on your configurations * The user follows the steps in the Interac UI The funds will be transferred as soon as both Interac and the bank process the transaction, which may result in a delay for the Zūm system to confirm the transaction's success. Once the transaction is completed, the funds will settle in the Zūm wallet. Please contact [support@zumrails.com](/transactions-and-payment-methods/transaction-times) for more details. ### Electronic Funds Transfer An electronic funds transfer (EFT) is the transfer of money over an online network. EFTs can be performed between the same or different banks. An EFT typically completes within 24 hours with Zūm Rails. There are three file transfer times during the day when we upload the transactions to the bank. Once the bank receives the file, the funds are withdrawn from the user’s account, usually in less than two hours. Each night at midnight, the bank sends us a confirmation report, and we send the funds to the destination account between 7 and 8 am EST the next morning. **File transfer times:** 6 am, 3 pm, and 7 pm EST. You can decide whether you would like funds to settle in the Zūm wallet or directly into your business account. You can send funds from your Zūm wallet to any account. #### EFT transaction time example An accounts receivable transaction is created from a user to a funding source at 1:00 pm ET. Zūm Rails uploads this transaction to the bank at 3 pm, and the funds are debited from the user’s account at 4:30 pm the same day. After Zūm Rails receives the confirmation from the bank the following midnight, we process the second part of the transaction to reach the funding source by 8:00 am. For this example, the EFT transaction took less than 24 hours. The time will vary depending on your flow and when you created the transaction. ### Visa Direct Visa Direct allows you to push and pull funds immediately with no delay upon confirmation of the transaction through using 3DS. Once you create the transaction, the funds will be sent, and you will receive the confirmation. Visa Direct works off of the card numbers on the Visa Debit card. It is not a cash advance; the funds will move to/from your Zūm Wallet. ### Credit Card Credit cards allow you to pull funds immediately. Once you create the transaction, the funds will be sent, and you will receive the confirmation. The funds are batched and settled overnight and then directed to your merchant account as per your terms. Credit card transactions can be refunded to the original purchase card. Please note that credit card processing for your account needs to be enabled via an additional approval process. Not every account can process credit cards. For additional information on processing credit cards or to add credit cards as a payment method, please contact [support@zumrails.com](/transactions-and-payment-methods/transaction-times) # Types of Available Transactions > There are 4 different transaction types (ZumRailsType): **Fund ZumWallet** - Send funds from the funding source to the Zūm Wallet. **Withdraw ZumWallet** - Send funds from the Zūm Wallet and send them to the funding source. **Accounts Payable** - Send funds from either the funding source or the Zūm Wallet to a user. **Accounts Receivable** - Send funds from a user to either the funding source or the Zūm Wallet. **Load Card -** Load funds into your pre-paid card # What Are Our Payment Methods? > Zūm Rails offers multiple payment methods that you use to manage your transactions safely and efficiently. #### Payment Methods **EFT** EFT is a direct bank account transfer between accounts and is one of the most popular forms of transferring funds in Canada. This method allows users or businesses to debit their chequing accounts for either a one-time or recurring payments. This payment method has no limits. **Interac** Interac is a method that is used to instantly push and pull funds to and from a bank account. It can be done through e-mail, SMS, or directly within a workflow. **Credit Card** Pull funds into a merchant account instantly and have them settle in a designated bank account the next day. **Visa Direct** Instantly push and pull funds directly to the user's checking account. Zūm tokenizes the Visa Debit number for future use and leverages the Visa Rails for instant payments. # What happens when a transaction fails > If a transaction fails, the funds are moved back to their place of origin. This is either done automatically or manually, depending on the destination. **Accounts Receivable from user to wallet:** Funds go back to the user’s account automatically. **Accounts Receivable from User to Funding Source:** On the back end, this is a two-step transaction. The first is from the user to the Zum wallet. The second is from the Zum wallet to the funding source. If the transaction fails in the first half (user to the wallet), the funds will go back to the user’s account automatically. If the funds clear the first step and fail after the second step is initiated (wallet to the funding source), this is considered a late failure, and the funds will need to be reversed back from the funding source to the wallet, manually. You will have to initiate another transaction from the funding source back to the wallet by using “Fund Zum Wallet”. **Account Payable from Zum wallet to a user:** Funds go back to the wallet automatically. **Account Payable from Funding Source to User:** This is a two-step transaction on the back end. The first step is from the Funding Source to Zum Wallet. The second step is from the Zum wallet to the User. If the transaction fails in the first half of the transaction, the funds will be directed back to the funding source automatically. However, if the transaction fails after the second half is initiated (wallet to the user), this is called a late failure, and the funds will need to be directed back to the wallet manually. # What will be displayed on the user's bank statement > There are a few options when deciding what you want your users to see on their bank statements. In your **Settings**, select **Payment Methods**, and click on EFT or VisaDirect. Go to Transaction Description. This is what will be displayed in your merchant's bank accounts.
There are two options: **Fixed** **or Per Transaction**. **Fixed** is when you define a transaction description for all transactions. The same thing will be displayed on your user's bank statements for every transaction. **Per Transaction** means that every time you create a transaction, the **memo** field will be required. What is defined in the memo field is what will be displayed on the user's banking information. # Why did my transaction fail? > There are many reasons why your transaction could have failed. The most common reason is due to NSF; other possibilities include the lack of email addresses, phone numbers, security questions, etc. Please refer to our documentation under **Transaction**, then under **Status and Events** to reference all possible event statuses, or click on the button below: Most transactions will fail within 2-3 days of the transaction initiation, but banking regulations allow for failures to occur even beyond this point. # Zum Rails - Interac Request Money Limits > Zum Rails – Interac e-Transfer “Request Money” Limits Guide This document outlines the Interac Request Money limits for personal banking accounts across major Canadian banks. Below, we provide a summary of per-transaction (single request) limits, daily limits, and longer-term limits (weekly/monthly) for each bank. Clients should use this information to configure their applications (e.g. setting maximum request amounts, handling errors) in compliance with each bank’s policies. All data applies to personal accounts (not business accounts) and reflects publicly available information as of the latest updates. #### Summary of Interac Request Money Limits by Bank (Personal Accounts) | Bank | Max per Request | Daily Limit | 7-Day Limit | 30-Day Limit | | ---------------------- | --------------------------------------------- | ---------------------------------------------------------- | ------------------------- | -------------------------- | | RBC (Royal Bank) | $10,000 per request | \*Tied to client card daily limit\* (often $2,500–$10,000) | \*N/A\* (No fixed 7-day) | \*N/A\* (No fixed 30-day) | | TD (TD Canada Trust) | $3,000 per request | $3,000 per 24 hours | $10,000 per 7 days | $20,000 per 30 days | | Scotiabank | \*Varies by account\* (often \~$3,000) | \*Varies by account\* | \*Varies by account\* | \*Varies by account\* | | BMO (Bank of Montreal) | $2,500–$3,000 per request (depending on acct) | $2,500–$3,000 per 24 hours | $10,000 per 7 days | $20,000 per 30 days | | CIBC (Imperial Bank) | $10,000 per request | $3,000 per 24 hours | $10,000 per 7 days | $30,000 per 30 days | | National Bank | $4,000 per request | $4,000 per 24 hours | $14,000 per 7 days | \*No set 30-day limit\* | | Desjardins | $5,000 per request | $5,000 per 24 hours | \*N/A\* (no weekly limit) | \*N/A\* (no monthly limit) | | Simplii Financial | $10,000 per request | $3,000 per 24 hours | $10,000 per 7 days | $30,000 per 30 days | | Tangerine | \~$3,000 per request (send) | $3,000 per 24 hours | $10,000 per 7 days | $20,000 per 30 days | #### Integration Guidelines for Zūm Rails Clients When integrating the **Interac Request Money** feature via the **Zūm Rails API**, it’s important to enforce the above limits on your end to prevent transactions that would be rejected by the banks. Here are some key guidelines: * If you want to be extra-safe: we recommend setting a CAD 3.000 limit per transaction * If not: we recommend setting a CAD 10.000 limit per transaction In case a CAD 10.000 request is created but the end user has a lower limit with their bank, let's say CAD 2.000. The end user won't be able to complete the transaction, and the transaction will expire. # Troubleshooting and Support # How Can I Contact Zūm Rails Support? > You can contact our support team by doing any of the following: * Email us at [support@zumrails.com](/troubleshooting-and-support/how-can-i-contact-zum-rails-support) * Use the chat bubble inside your portal to send our support team a message. Once you have submitted your question, the answer will be sent back to the email listed in your portal. # How Do I Change or Reset My Password? > You can easily reset your Zūm Portal password by completing the following steps. This process is valid if you have forgotten your password or simply want to change it. 1. Click on **Forgot Password?**
2. Enter your **Email** and click **Send Reset Link**
3. You will receive an email. Click on the link provided and create a **new password** 4. Test your **new password** # How do I reset my portal password? > To reset your password: 1. Click **Forgot Password?** on the portal login page.
2\. Enter your email address registered with Zūm Rails, and click **Send Reset Link**.
3\. An email will be sent to your email address with a link to reset your password. 4. Click on the link in the email or copy the URL into your browser. 5. Once the page opens, confirm your registered email address, and choose a new password.
6\. Click on **Set New Password** once complete. # Retrieving Your Account's API Keys > Zūm Rails offers one set of API keys per account.\ > You can retrieve these API keys through your portal. 1. Log in to your **Portal** 2. Click on **Settings > Webhook & API Settings**
3. Scroll down to **Webhook & API Settings** 4. To access the API password, click **Generate New.**
*You will see the API Username under the field Username. The Username will always be on this page and **cannot be changed**.* 5. Fill in your **account** **password**
6. Securely save the API password once it is generated. If you lose your password, you will need to generate a new one. # System Status Page > Our status page allows you to view: * Current operational status * Uptime over the past 90 days * Historical uptime * Past and ongoing incidents by date and issue You can check the status of Zūm Rails anytime by visiting [Zūm Rails Status](https://zumrails.statuspage.io/). You can also set up notifications to receive real-time alerts about any outages or incidents that may occur. **Steps to set up notifications** * Go to [Zūm Rails Status Page](https://zumrails.statuspage.io/) * Click **Subscribe to updates** * Select your **method** of notification: email, slack, or directly from within your portal. If you select **portal**: Click on the live chat icon at the bottom right of the page. # What do I do if my wallet goes negative? > A negative wallet is like a cash advance and we’ll kindly ask you you create a transaction to bring the wallet back to $0 or higher. ### Why a wallet balance might be negative. The main culprit forof this comes from **late failures**. A late failure is a transaction that is originally considered successful, but due to a number of factors, it **fails later.** To correct this, please create a new transaction to fund the wallet in the amount that failed. # What do I do when I get locked out of my account? > If you get locked out, all you need to do is reset your password. To reset your password, please reference this article:[ How do I reset my portal password?](/troubleshooting-and-support/how-do-i-reset-my-portal-password) # Underwriting: Customers and Partners # Adding Documents Through Your Portal > Submitting documents within your portal is an easy and secure way to send in important applications, government IDs, and void cheques to our Sales Support team. **Steps to upload a document** 1. Click on **Settings > Documents > Add New Document**
2. Select the **document type** you want to upload from the dropdown menu 3. **Attach** the corresponding file. Make sure that any photos and documentation are clearly visible. If not, our team will request that you send new documents and this will delay your overall onboarding process. 4. Click on **Upload** # Completing Your Persona Identity Check > As a new customer of Zūm Rails, you will be required to complete an identity check through a tool called Persona. Depending on the structure of your business other owners may also be required to complete the same steps. ### {% embed url="" %} ### Completing your identity check **Steps** 1. Click on the **link** provided to you by our Zūm Rails team 2. Select your **language** and click **Begin verifying** 3. Select your **country** and enter your **phone number** 4. You will receive a confirmation code through SMS. If you do not, click on **resend confirmation code** 5. Enter the **confirmation code** and click **Continue** 6. Enter the country from where your **government** **IDs** are issued 7. Select which **government ID** you will upload 8. Take a **picture** of the **front** of your ID or upload one from your current device. You can also continue the process on another device if your pictures are not stored on the current one or your current device does not have a camera option. 9. **Verify** that the photo of your ID is clear and all lettering is **visible.** If the Underwriting team cannot properly review your ID, it will extend the overall onboarding process of your account. Click **Use this photo**. 10. Take a **picture** of the **back** of your ID or upload one from your current device. You can also continue the process on another device if your pictures are not stored on the current one or your current device does not have a camera option. 11. **Verify** that the photo of your ID is clear and all lettering is **visible.** If the Underwriting team cannot properly review your ID, it will extend the overall onboarding process of your account. Click **Use this photo**. Your ID will be reviewed automatically once you click **Use this photo**. If it is not valid (expired, blurry, etc.), you will be prompted to restart the process. If the ID is valid, the next step will automatically appear. 12. You will be prompted to take multiple pictures for identification purposes. Persona leverages facial biometrics for the purpose of identity verification only. To start the process, click **Get Started**. 13. Remove your **glasses** before clicking on the camera icon If the pictures are incorrectly taken, you will be prompted to restart the process. 14. Once you have successfully taken your pictures, a **confirmation** will appear showing you have completed your persona identification process. 15. If there are any additional documents needed, our team at Zūm Rails will reach out to you directly. # Completing Your Zūm Rails Application > Every customer must complete a Zūm Rails application. This allows our teams to capture all the relevant information to help us set up your platform. The more accurate your information, the faster the onboarding process. {% embed url="" %} Below is a guide to help accurately fill in all the sections of the application. [Completing Part A](/underwriting---customers-and-partners/completing-your-zum-rails-application) [Products and Services](/underwriting---customers-and-partners/completing-your-zum-rails-application) [1.0 General Information](/underwriting---customers-and-partners/completing-your-zum-rails-application) [2.0 Corporate Personnel](/underwriting---customers-and-partners/completing-your-zum-rails-application) [3.0 Politically Exposed Persons Determination](/underwriting---customers-and-partners/completing-your-zum-rails-application) [4.0 Banking Information](/underwriting---customers-and-partners/completing-your-zum-rails-application) [5.0 Transaction Requirements and Payments Needs](/underwriting---customers-and-partners/completing-your-zum-rails-application) [Completing Part B](/underwriting---customers-and-partners/completing-your-zum-rails-application) [Checklist](/underwriting---customers-and-partners/completing-your-zum-rails-application) ### Completing Part A Unless indicated, every section in part A of the application must be filled out. ### Products and Services The first step you will see on the application is a checklist for products and services. Check all those you want to apply for as this will impact offered pricing and underwriting. You must select at least **1 product or service**. If you select 1 or more payment methods, you will need to fill in the corresponding fields [**in Section 5**](/underwriting---customers-and-partners/completing-your-zum-rails-application) If you are unsure, you can always add more products and payment methods once you have finished your onboarding process. If you decide to add additional products or payment methods during your onboarding process, this will extend the overall time to finalize your Zūm Rails integration. ### 1.0 General Information In this section, **all fields** must be filled in except for the following: * MCC Code * MCC Description * Fax Number #### What is the difference between a business registration number and a business number? A **business registration number** (also known as a business identification number or BIN) is a 9-digit number that is the standard identifier for your business or legal entity. A **registration number** is the number on your articles of incorporation. Neither of these numbers is the numerical name of your business (i.e. 96583010 Canada Inc.) ### 2.0 Corporate Personnel This section is specifically about the owners, shareholders, directors, etc. of your business. Depending on your structure, you may need to fill out some or all fields. #### Beneficial Owners Beneficial owners are individuals, corporations, or other entities who own **25%** **or more** of your business. If you have any beneficial owners who own 25% or more of your business, you will need to list all of them here: **Requirements based on ownership type** * A business owns 25% or more: The owner of that business must provide the required information * Investor(s) owns 25% or more: Each investor must provide the required information If you are unsure how to proceed due to the structure of your company, please contact [salessupport@zumrails.com](/underwriting---customers-and-partners/completing-your-zum-rails-application) #### Directors and Officers Make sure to fill in a line for each current director and officer working in your company. Note that there may be a cross-over. If so, please include the relevant information for both. ### 3.0 Politically Exposed Persons Determination In this section, you must identify **all individuals** working in or around your organization that have political affiliations. If there are none, check **No**. ### 4.0 Banking Information In this section, enter the information of the account you want to connect to the Zūm Portal. Note that the PAD and the application must be **the same account**; if not, this will cause delays in your overall integration. ### 5.0 Transaction Requirements and Payment Needs In this section, **only fill out** the sections you indicated at the beginning of your application (e.g. if you checked EFT, fill out section 5.1). Zūm Rails requires that you fill out **every field** for both send and receive. Once you have submitted your application, you will **not be allowed** to change your limits for the first 90 days of your processing. This does not include time to integrate. Please make sure all your numbers are accurate. Once you have finished filling out Part A of the application, make sure to review your information to ensure its accuracy. ### Completing Part B Part B is the overall agreement you are entering into with Zūm Rails. Please make sure to **read through** each section before signing. Once you have read through the agreement and reviewed all your information, sign under the section called **Company.** ### Checklist In addition to the application form, you will receive a requirements checklist of all the documentation you will need to **submit in PDF format** for your underwriting process. Here is a list of the current documents you must submit for underwriting: **Required Documents** * Zūm Rails completed the Merchant Account Application * Copy of Business Registration or Articles of Incorporation * One utility bill within the last 90 days * Funding source void cheque or PAD agreement * Funding source: 2 months of bank statements * Proof of ownership (one of the following documents) * Stock certificate * Shareholder register * Shareholders' agreement * Certificate of incumbency * CPA business owner verification document * Current T2 Schedule 50 * Or, if a Non-Profit Organization: * Copy of certificate of registration * List of all board members * Certified document confirming the names of all directors Your **void cheque or PAD agreement** must show both\*\* the company name\*\* and **the account number.** This must be submitted in **PDF format**. Laptop screenshots, mobile screenshots, or any other type of submission will not be accepted. Your Bank statements must show both\*\* the company name\*\* and **the account number.** This must be submitted in a **PDF format**. Laptop screenshots, mobile screenshots, or any other type of submission will not be accepted. If your **proof of ownership** shows a parent company, you will be required to provide additional documentation to verify ownership. #### **Name Changes** If your company has undergone any name changes, you will need to submit additional documentation to verify those changes. Once you have collected all your documents in **PDF format** and have finished your application, please submit the package back to our Zūm Rails team to begin the underwriting process. # How can I submit documents for underwriting? > You can submit underwriting documents directly in your Portal or through the API. **Through the portal**: First, log in and follow these steps: 1. Select **Settings** from the menu on the left side of the page 2. Click on the **Underwriting** tab 3. Select the type of document you would like to upload using the drop-down menu **Underwriting Type** 4. Attach a file, then click on **Upload** # How Do I Request a Limit Increase > During your onboarding process, you will be required to submit your expected limits for the first 90 days of processing. Once the 90 days have expired, you can submit a request for new limits. This process is also valid for a one time limit increase. ### Submitting a limit increase request **Steps** 1. Email [support@zumrails.com ](/underwriting---customers-and-partners/how-do-i-request-a-limit-increase)with your request 2. You will receive a form to fill out and send back to the same email string 3. Our Zūm Rails team will review your request and come back to you with a decision Please note for any limit increase the processing time can take anywhere from 24 to 72 hours. # Onboarding New Customers Through Partner Accounts > Adding and managing customers is an important part of of your partner account with Zūm Rails. See how you can add a customer through your partner portal. 1. Log in to your **partner portal** 2. Go to **Customers > Add new**
3. Complete the **Account Details page**, then click **Save and proceed to Payment Methods**
By checking **Send activation email and let the customer define the password? (recommended)** you allow your customer to define their own password and gain access to the Zūm portal. If you do not want the customer to access to the Zūm portal simply uncheck the box. By unchecking the box, you will have to create and manage the customer's password. 4. Complete the **Payment Methods page**, then click **Save and proceed to Billing**. The payment methods the customer has been approved for will dictate which ones can be enabled.
5. Add **Billing** to the client's environment, then click \*\*Save and exit. \*\*Customer billing is specified on their schedule A in their contract.
You can use the toggle to hide the billing page information from clients.
An email will be sent to the customer for them to activate their account and link their funding source. If you have any questions, please contact # Submitting a Partner Customer Onboarding Form > As a partner, you will be required to gather and submit information for each customer you onboard with Zūm Rails. The intake form you receive from our team is used to start the application process for a new customer. Customer application form sample:
### Finalizing the customer onboarding form To finalize your customer onboarding form, complete the following steps. * Fill out all the fields on the form. Make sure that all contact information is correct, as our team uses this to send the customer documents for final signature. * Send the completed form to [salessupport@zumrails.com](/underwriting---customers-and-partners/submitting-a-partner-customer-onboarding-form). Once Zūm Rails receives your customer onboarding form, our Sales Support team will issue a full application to your new customer. Your customer will then be required to: * Work with Sales Support to complete their submission package * Go through the underwriting process * Submit additional documents as required to complete the onboarding process You can review the underwriting process [here](/underwriting---customers-and-partners/submitting-a-partner-customer-onboarding-form). If you have already collected any of the required documentation from your customer, please make sure to send it when you send your customer onboarding form. # Underwriting at Zūm Rails > No matter if you are a customer or a partner, your onboarding journey with Zūm Rails requires you to go through underwriting. We will only ever ask for the required documents relevant to your application. During the underwriting process, you can expect to complete the following steps: * Submit a signed contract with your required documents * Connect a funding source * Be requested to submit additional documentation as needed for approval ### Submitting your required documents and contract Upon receiving your contract you will also receive a checklist of required documents necessary for our team to begin your application process. We will only ever ask you for the required documents that will allow us to complete your application. **Required Documents** * Zūm Rails completed merchant account application * Copy of Business Registration or Articles of Incorporation * One utility bill within the last 90 days * A government photo ID, required for each majority owner * Funding source void cheque or PAD agreement * Funding source 2 months of financial statements * Proof of ownership (one of the following documents) * Stock certificate * Shareholder register * Shareholders' agreement * Certificate of incumbency * CPA business owner verification document * Current T2 Schedule 50 * Or, if a Non-Profit Organization: * Copy of certificate of registration * List of all board members * Certified document confirming the names of all directors Depending on your application process you will be asked to upload the above documents through: * DocuSign * Email * URL link #### Reasons your application may be delayed * One or more documents submitted are illegible. Our team will reach out and request a new copy. * You did not return your contract signed within 45 days. Our team will issue a new contract after 45 days. * You forgot to submit one or more documents as part of your general application ### Connecting your funding source In addition to submitting your documents, you will be asked to connect a valid business funding source through aggregation. Follow the steps to connect a funding source [here](/underwriting---customers-and-partners/underwriting-at-zum-rails). #### Funding source statuses **Pending Funding Source:** A business funding source has not yet been connected **Pending Underwriting:** A business funding source has been connected and is under review by our Underwriting team **Active/Rejected:** Status of the added funding source #### Failing to connect a funding source In the event that you cannot connect your funding source please contact [support@zumrails.com.](/underwriting---customers-and-partners/underwriting-at-zum-rails) ### Zūm underwriting process Once you have submitted all required documents, a signed contract, and have connected a funding source, Underwriting will review all the details, and documents, and ensure the aggregation is successfully connected. #### Underwriting steps - approved * Underwriting reviews all documents and funding sources submitted. Depending on the review, our Sales Support team may reach out for additional documents as needed. * Underwriting approves the application. * Once the application has been approved, Sales Support will reach out and confirm the application approval and the transaction limits that were granted for the account. #### Underwriting steps - declined * Underwriting reviews all documents and funding sources submitted. Depending on the review, our Sales Support team may reach out for additional documents as needed. * Underwriting declines the application. * Sales Support will reach out to you directly to notify you of the decision. If there you have any questions please contact [support@zumrails.com.](/underwriting---customers-and-partners/underwriting-at-zum-rails) # What Is My Data Security Compliance Level > Merchant level tiers are based on their total transaction volume over a 12-month period. Identifying which level fits your business determines the requirements to validate for PCI DSS compliance. ### PCI DSS Compliance Levels #### Level 4 Merchant Merchants processing less than 20,000 Visa e-commerce transactions annually and all other merchants processing up to 1 million Visa transactions annually. * Self-Assessment Questionnaire (SAQ) * Attestation of Compliance (AOC) * Proof of Quarterly network scan by an Approved Scan Vendor (ASV) #### Level 3 Merchant 20,000 to 1 million e-commerce Visa transactions annually. * Self-Assessment Questionnaire (SAQ) * Attestation of Compliance (AOC) * Proof of Quarterly network scan by an Approved Scan Vendor (ASV) #### Level 2 Merchant 1 to 6 million Visa transactions annually across all channels. * Self-Assessment Questionnaire (SAQ) * Attestation of Compliance (AOC) * Proof of Quarterly network scan by an Approved Scan Vendor (ASV) #### Level 1 Merchant Merchants processing over 6 million Visa transactions annually or Global merchants identified as level 1 by any Visa region. * File a Report on Compliance (""ROC"") by a Qualified Security Assessor (""QSA"")” or Internal * Auditor if signed by an officer of the company. We recommend the internal auditor obtain the * PCI SSC Internal Security Assessor (""ISA"") certification. * Submit an Attestation of Compliance (""AOC"") Form * Proof of a quarterly network scan by an Approved Scan Vendor (""ASV"") If you are unsure which level your business belongs to, please contact [support@zumrails.com](/underwriting---customers-and-partners/what-is-my-data-security-compliance-level) for assistance. # What is PCI DSS Compliance > The PCI Data Security Standard (PCI DSS) is a global standard that provides a baseline of technical and operational requirements designated to protect payment data. All businesses storing, processing, or transmitting cardholder information are required to follow the Payment Card Industry Data Security Standard (PCI DSS). It consists of 12 basic requirements grouped into 6 categories for establishing and maintaining a reliable and secure payment processing environment. Review the guidelines, to check and see if you meet the listed requirements. #### Build and maintain a secure network * Install and maintain a firewall configuration to protect cardholder data. * Do not use vendor-supplied defaults for system passwords and other security parameters. #### Protect cardholder data * Protect stored cardholder data. * Encrypt transmission of cardholder data across open, public networks. #### Maintain a vulnerability management program * Protect all systems against malware and regularly update anti-virus software or programs. * Develop and maintain secure systems and applications. #### Implement strong access control measures * Restrict access to cardholder data by business need-to-know. * Identify and authenticate access to system components. * Restrict physical access to cardholder data. #### Regularly monitor and test networks * Track and monitor all access to network resources and cardholder data. * Regularly test security systems and processes. #### Maintain an information security policy * Maintain a policy that addresses information security for all personnel. To find the most up-to-date information on PCI DSS Compliance, click [here](https://www.pcisecuritystandards.org/document_library/). #### Articles you might like [What Is My Data Security Compliance Level](/underwriting---customers-and-partners/what-is-pci-dss-compliance) # Users # Adding a New User ### Adding a new user through the portal {% embed url="" %} 1. Log in to your **portal** 2. Click **Users > Add new**
3. Select the **Account type** 4. Enter the **General information** * **Email** - This will not send out an automatic email to the user. It just helps create a unique ID for the user * **Phone Number** - Optional 5. Click **Save.** The user will then be added to the database. \*Note: *The user will display as **Not Connected**. This is normal; you can still send funds to and from this user. Not Connected means they're not connected through aggregation. To set up a connected user, you need to use \*aggregation.* ### Adding a new user through Aggregation The integration code to add a payment profile is an out-of-the-box solution. It is a URL you can: * Embed it into your web app * Send it directly to your user via email or SMS * Display it on your computer for walk-in clients Aggregation allows a user to link their bank account within minutes giving you access to their banking data and information. Their account verification is done almost instantly without the need for void cheques and bank statements. You can retrieve your payment profile (aggregation) URL by completing the following steps. 1. Log in to your **portal** 2. Click **Settings > Integration Codes**
3. Click **Add Payment Profile**
4. Copy the **URL.** You can: * embed the URL in your web app * open it in any browser You can customize the appearance of the link through **Settings> Brand Customization** in your portal. You can also limit the options displayed by adding parameters to the URL. ### Adding a new user through the API **Useful tips** * By bypassing the user object in the payload, you will initiate the transaction and generate a user profile so you can use the userID returned in the API response in future transactions. * If you are using webhooks, you will receive a response each time the user status and transaction history update. There are two different ways to create a new user using the Zūm API. #### Option 1: Calling the user endpoint By using this option, you are only creating a user that you can use to create transactions at a later date. **{{env}}/api/user** #### Option 2: Calling the transaction endpoint and passing the user object By using this option, you are creating a user profile and a transaction at the same time. **{{env}}/api/transaction** # Adding Users through Aggregation > Aggregation is the most effective method to add users. This provides you insight into their financial data in a matter of minutes. You can then make informed decisions quicker. ### Adding a user through aggregation 1. Render the **iframe.** You can view how to do this in the article [Adding a New User - Portal](/users/adding-users-through-aggregation) 2. The user fills out the **required information** 3. Click on **Agree** after reading the consent section 4. Select your **banking institution**
6. Enter your **banking credentials**. By completing this step, you allow Zūm Rails to connect to your selected bank account and retrieve your financial data. 7. User goes through MFA (multifactor authentication) * Users must select if they want to connect a **savings** or **chequing** account and click **Continue** * The user is redirected. The collection of their banking information occurs in the background and can take up to 3 minutes. ### Retrieving and verifying user information Once a user has successfully connected through aggregation, you can proceed with any of the following. * Retrieve the financial data through webhooks, API, or manually through your portal * Have an overview of all the connections from your portal ### Failing to connect through aggregation If a user fails to connect through aggregation, complete the following steps. * Request that the user repeat the same steps and attempt to connect again * Review the API response * Reach out to our support team at [support@zumrails.com](/users/adding-users-through-aggregation) # Adding Users With Embedded Integration Codes > You can use integration codes provided in your Zūm Portal to set up instant verification of users' account information. Using this method allows you to collect account information and other required details in a matter of minutes. Adding a new user through aggregation using Integration Codes 1. Log in to your Zūm Rails **portal** 2. Go to **Settings > Integration Codes**
3. Click the arrow on the right of **Add Payment Profile** card
4. **Copy the URL**. Depending on your workflow, you can do any of the following: * Open the URL in any browser * Embed the URL in a web application * Sent the URL by email or SMS 5. Depending on your workflow and settings, your users will be required to fill in some, or all of the information.
When a user successfully completes all the steps, it will create their profile in the Zum Rails database. This process does not create any transactions. ### Verifying the connectivity of users #### Through the portal To confirm that a user has successfully connected through aggregation you can view their profile and look at their status 1. Click on **Users**
2\. Search by **User name** or by **status**
3. Click on the **User name** 4. Confirm that the **Aggregation Status** is **Connected**
#### Through the API Once a user has completed the process and you have received a userID, you can call the **`GET /user endpoint /api/user/{user_id}.`** “AggregationStatus”: “Connected” # Best Practices For Adding Users > Adding users is quick and easy. Here are some tips to help ensure you maximize your success every time. ### Underwrite your users While not mandatory, we always recommend you underwrite your users. Ensure you have the proper documentation to support new users and that they are cleared to use any level of access you give them. If you use aggregation to add users, you have automatic access to a wealth of information to help make your decision. Remember, a user who has not been properly vetted can pose a threat to your business. For best practices on how to vet your users, we recommend visiting the [Government of Canada FINTRAC website.](/users/best-practices-for-adding-users) ### Have a backup plan for your aggregation flow Zum Rails has an amazing option that allows you to add users through aggregation. This means that you can see their financial data and make informed decisions. If your user cannot be added through aggregation, make sure to have a manual backup. You can add the user manually through your portal or the API using a blank cheque or any other method you use to collect banking information. Users going through aggregation **must accept** PAD. If a user goes through a manual or an API process, you will need to handle the PAD agreement on your side. # Deleting a User > In the portal: 1. Open your portal and locate the Users menu on the left sidebar. 2. Once in the Users tab, you can locate the user by using the search bar. 3. Then click on **Search**, your results will appear in the user's list below the search box. 4. Locate your user in question, then click on the three dots at the far right. 5. Click on the **Delete** option from the menu that appears
6. A confirmation message will appear; click **Delete**
# Searching For a User > You can search for users by navigating through your portal or using the API. ### Through your portal 1. Log in to your **portal**. 2. Select **Users** from the left menu bar.
3. Use the search bar to write the name or email and click **Search**. Your results will be shown below.
# What is a User > A user is your customer to whom money is sent, or from whom money is debited. You can add a user manually through the portal or using the API. They can also connect their credentials (bank account, credit card, etc.) through Zum Connect. Once a user is saved in the system with the appropriate credentials for the payment method, you will be able to pull from or push funds to their accounts. That user remains in the system as a tokenized UserID for future transactions. If they connect with Zum Connect, they will be prompted to accept a PAD at that time. # What is Zūm Connect? > Zūm Connect is an iFrame that allows you to get instant account verification for your users. That means, rather than waiting for them to send you their void cheque and bank statements, they can link through Zūm Connect and you’ll get that information in minutes. Zūm Connect also handles the PAD agreement for your users. In the iframe, you can add your company’s logo and colour for a more white-labeled experience. # Why Does The User's Status Say “Not Connected”? > This is a status for the aggregation status of the user in particular. “Not Connected” indicates that the user was added manually and not through aggregation (Zum Connect). All this means you cannot view their balance and bank statements, but you can still create transactions to/from this account. #### **Transfers will still occur to and from their account.**