Deposit Sweeps
Cross River offers a set of APIs to enable actions related to our sweep offerings that will be helpful to your customers.
IntraFi Sweeps APIs are found in the SweepsIntraFi module of our sandbox.
Get started with Cross River APIs.
This table presents APIs we describe in detail.
Action | API Call | Description |
|---|---|---|
GET/SweepsIntrafi/v1/accounts/{accountNumber} | GET call to get account details of a COS account enrolled in Sweeps | |
PUT/SweepsIntrafi/v1/accounts/{accountNumber} | PUT call to exclude specific bank or opt out specific account from Sweeps. | |
GET/SweepsIntrafi/v1/banks/{bankNumber | GET call to get bank name for a specific BankID | |
GET/SweepsIntrafi/v1/banks | GET call to get a list of all banks |
The GET/Accounts call can be used to read an account enabled for sweeps. It will relay many important data points such as the following
- Core balance - total available balance at CR
- Network Balance - total amount swept to IntraFi
- Custodial Balance - total amount held at CR
- Balances array - which relays where the account’s deposits are held
- Max sweep amount will always be 0 as it refers to an override - program sweep limit is not reflected here.
The PUT/v1/accounts call will give you the ability to do the following:
- Exclude banks from the sweep network. Your customers may already have funds at a certain bank and this is a way to exclude
- Opt out of sweeps When a product is enabled for sweeps, all accounts get enrolled into the sweeps program. Using this endpoint you can mark an account inactive for sweeps, effectively opting out for sweeps.
The previous endpoints have shared strings of Bank ID’s when sharing exclusions. This endpoint will return the bank name.
This will get you a list of all banks.
Event Name | Description |
|---|---|
Sweeps.Intrafi.Account.Updated | Sweeps related data on the account record has changed |
You can learn more account management in general at Account management
There are no tutorials available at the moment for this topic.