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 register with cross river apis this table presents apis we describe in detail action api call description deposit sweeps docid\ uyr7bswwh4yj71w1uqx1o get/sweepsintrafi/v1/accounts/{accountnumber} get call to get account details of a cos account enrolled in sweeps deposit sweeps docid\ uyr7bswwh4yj71w1uqx1o put/sweepsintrafi/v1/accounts/{accountnumber } put call to exclude specific bank or opt out specific account from sweeps deposit sweeps docid\ uyr7bswwh4yj71w1uqx1o get/sweepsintrafi/v1/banks/{banknumber get call to get bank name for a specific bankid deposit sweeps docid\ uyr7bswwh4yj71w1uqx1o get/sweepsintrafi/v1/banks get call to get a list of all banks get accounts 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 put accounts 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 get banks{bank number} the previous endpoints have shared strings of bank id’s when sharing exclusions this endpoint will return the bank name get banks this will get you a list of all banks associated webhook events event name description sweeps intrafi account updated sweeps related data on the account record has changed related documents you can learn more account management in general at account management docid\ dtshf52ayohqs2tku09el tutorials there are no tutorials available at the moment for this topic