Accounts
8 min
cross river offers a set of apis for account management in our banking core get api credentials with cross river apis once you have access to our sandbox environments you can access these api endpoints in the core module, dda section, through swagger links get calls add query parameters to filter the response the api returns to general get calls use pagination to control presentation of your results account management this table presents general account management apis that we describe in detail important only pull tax documents as needed if you want to pull a large number of documents, speak to your relationship manager action api call description open account post /core/v1/dda/accounts creates an account based on the product id for that type of account this includes cd (time deposit) accounts tax document list get /core/v1/dda/accounts/{accountnumber}/tax documents/ gets a list of tax documents for a given account, including ids for each tax document get /core/v1/dda/accounts/{accountnumber}/tax documents/{id} retrieves a pdf of a specific tax document subledgers in subledger api endpoints, subledgers are referred to as subaccounts , for example, post /core/v1/dda/subaccounts creates a new subledger this table presents the subledger management apis we describe in detail action api call description create subledger post /core/v1/dda/subaccounts creates a new subledger subledger info get /core/v1/dda/subaccounts/{accountnumber} returns information on a specific subledger account time deposit (cd) this table presents time deposit (cd) apis that we describe in detail action api call description early funds withdrawal post /core/v1/dda/accounts/{accountnumber}/time deposit/early withdraw requests to withdraw the funds from a time deposit account before the account reaches maturity cd activity get /core/v1/dda/accounts/{accountnumber}/time deposit returns information about the account activity of a specific time deposit account cd penalty fee get /core/v1/dda/accounts/{accountnumber}/time deposit/penalty fee returns the projected penalty fee if you make an early withdrawal to an active time deposit account deposit sweeps once you have access to our sandbox environments you can access these api endpoints in the sweepsintrafi module through swagger links this table presents apis we describe in detail action api call description account details get/sweepsintrafi/v1/accounts/{accountnumber} get call to get account details of a cos account enrolled in sweeps exclude bank/account put/sweepsintrafi/v1/accounts/{accountnumber } put call to exclude specific bank or opt out specific account from sweeps identify bank get/sweepsintrafi/v1/banks/{banknumber get call to get bank name for a specific bankid bank list get/sweepsintrafi/v1/banks get call to get a list of all banks related topics webhook events tutorials open an account create a deposit account open a subledger create a subledger (virtual account) withdraw cd funds early withdraw funds from a certificate of deposit before it reaches maturity