Platform & Key Concepts

Companies use Railz to gain access to the majority of financial service providers used by small and medium-sized businesses and enable on-demand access to normalized financial transactions, reports, and insights on those businesses so they can quickly, easily, and inexpensively make decisions based on a business's financial health.

Products and Environments

Product / EnvironmentDescription
Railz APIThe Railz API is a RESTful interface for creating and managing your Railz integration. It supports webhooks to give you real-time updates about events in your integration. Learn more and browse available endpoints to make requests: Railz API.
Railz Connect™Railz Connect is a plug-and-play widget that provides a secure, elegant authentication flow for each integration that Railz supports. Learn more: Railz Connect.
Railz Sites™Railz Sites is a secure, no-code Railz-hosted page, powered by the Railz API & Railz Connect™, that lets your business customers connect their financial data. Railz Sites.
Railz Analytics™Railz Analytics™ allows you to access enriched data to feed your models and gain a better understanding of your business customers' behaviour — without having to deal with any of the tedious tasks that arise when working with raw data. Learn more: Railz Analytics.
Railz Dashboard™Railz dashboard is a web-based portal that allows you to manage your account, integrations and to use our platforms with no code to view your connected businesses, their data and a set of financial visual summaries. Learn more Railz Dashboard.
RecipesSimple way to walk your developers through code samples step by step to help them get started with the Railz API faster.
Sandbox EnvironmentA free and fully-featured environment for application development and testing. Learn more: Sandbox.
Production EnvironmentThe live environment for your integration to connect to multiple real business connections and use the full Railz service.

Key Concepts

Throughout this documentation, you will come across a number of key concepts and terms used throughout our Products:

Concept

Description

Next Steps

Business

A business represents an SME that granted you access to its financial data. Each business has one or more connections to a Railz supported integration.

Learn more about businesses

Connection

A connection represents a unique authorized data connection between a business and one of their financial service providers, such as an accounting system or bank account.

Learn more about connections

Integration

An integration is the ability to connect to a financial service provider used by a SME, such as QuickBooks and Plaid integrations

Railz designs, builds and maintains all integrations with the service providers through their APIs.

Learn more about integrations

View supported integrations & data types

Data Synchronization

Railz supports a two-way synchronization to the financial service provider used by a business.

Learn more about synchronizing data

Learn more about pushing data

Webhooks

Railz allows you to receive webhook notifications for a number of events, such as when a connection was successful/disconnected or business data has been refreshed.

Learn more and setup webhooks

Users

Railz allows you to add team members (users) to your account, with different roles and permissions.

Learn more about managing your team

Beta

We use the Beta support label to indicate functionality, integrations and data types for which we've not experienced high usage compared to others. Beta features go through our testing process and are suitable for customer use with a disclaimer that there is a chance of encountering new edge cases compared to others. Beta features are subject to changes outside of our versioning policy. We recommend getting in touch with our product and integration support team before using Beta features in production.

Railz supports two types of Betas, a Private Beta limited to paid plans only and an Open Beta available to the general public,

View supported integrations & data types


Read Next

Try out the platform right now.

Did this page help you?