Data Sources

Hurdlr's Income Streams API sits directly on top of your Plaid or MX integration. If you don't have an integration yet, Hurdlr enables you to skip past the burden of building your own back-end to store all that transaction (and related) data. Or, if you already have an integration, you can leverage Hurdlr's Income Streams API to enrich the data you're already storing.

Once you have your data source integration interfaced with the Hurdlr API (less than one calendar day of labor), you can immediately start using all of Hurdlr's Income Streams functionality.

1. Connecting your Plaid or MX integration

Please reference our Plaid integration or MX integration documentation for detailed instructions on connecting your data sources with the Hurdlr API.

2. Displaying the user's income and allowing them to make edits

You can easily allow your users to view their income transactions and make quick edits, including the ability to split across multiple revenue accounts, by rendering Hurdlr Embedded's Income Dashboard.

3. Programmatically getting the user's income

If you are building your own user experience or want to perform programmatic processing on a user's income transactions, you can retrieve those revenues from the Hurdlr API.

On each revenue, you may find the following attributes to be of particular interest:

Field	Description	Format
id	Id of the revenue record	Numeric
type	Type of revenue	Must be one of the following: "PENDING", "BUSINESS", "NOT_BUSINESS"
date	Date that the revenue was deposited	`yyyy-MM-dd'T'HH:mm:ss.SSSZ`
amount	Total value of the deposit	Numeric, with 2 decimal places
lastUpdatedDate	Last date/time that this record was modified	`yyyy-MM-dd'T'HH:mm:ss.SSSZ`

Additionally, several attributes to help you or your user identify a bank transaction are listed below:

Field	Description	Format
bankDescription	Transaction description (similar to what will show on the user's bank statement)	Any string
apiInstitutionId	Id of the institution that the transaction originated from	Any string
apiAccountName	Display name for the user's bank account	Any string
apiAccountNo	Mask of the user's bank account, often the last 4 digits of the account number	2-4 Alphanumeric characters
plaidItemAccountId	Id of the bank account that this transaction originated from (within Hurdlr's API)	Numeric
apiName	Name of the API that this transaction originated from	Will always be "PLAID", unless you are utilizing one of Hurdlr's other direct integrations
apiPaymentId	Id of the transaction record in Plaid's API	Any string