Accounts

accounts apis cross river offers a set of apis for account management in our banking core get started docid\ z mvwov p00 xx082nabk with cross river apis get calls add query parameters to filter the response the api returns to general get calls use pagination docid 6ekvquywevh9x4zxmuklj to control presentation of your results account management this table presents general account management apis that we describe in detail important only pull statement and 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 docid\ abkdizokhxlsswzwrbbj1 post /core/v1/dda/accounts creates an account based on the product id for that type of account this includes cd (time deposit) accounts restrict account docid\ eickx6djcuo3cryrih8mp post /core/v1/dda/accounts/{accountnumber}/restrictions restricts an account from defined transaction types remove restriction docid\ qxdrgzjupefeuxz6okfob delete /core/v1/dda/accounts/{accountnumber}/restrictions/{id} removes a previously applied restriction from an account get statement info docid\ ihy7u89hoidgyk 84ebzc get /core/v1/dda/accounts/{accountnumber}/statements returns bank statement information for the specified account get statement doc info docid 4tf9s1ugk6evhifgq2zfs get /core/v1/dda/accounts/{accountnumber}/statements/{statementid}/documents returns information about monthly statement documents using a unique statement id returned in the get statement info call get statement pdf docid 0ufqttk tyvg zf44h0cr get /core/v1/dda/accounts/{accountnumber}/statements/{statementid}/documents/{documentid} returns a pdf of the requested statement document in raw format tax document list docid\ t5k0qew58pettey4qlg2j get /core/v1/dda/accounts/{accountnumber}/tax documents/ gets a list of tax documents for a given account, including ids for each tax document docid\ hhdtdvsponrejhjt 0rhw 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 docid\ k40f8ih5snvtbabcej1mr post /core/v1/dda/subaccounts creates a new subledger get subledger info docid\ rl2wj6moxgl oegwh5hzp 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 docid\ bheqf948uol69c872o299 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 docid 9nab7nqgegfipdq8fldjf get /core/v1/dda/accounts/{accountnumber}/time deposit returns information about the account activity of a specific time deposit account cd penalty fee docid\ e4daa6xwq3zpau6wmqr c 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 this table presents apis we describe in detail action api call description account details docid\ q6s6db3yl7lxocbsghizn get/sweepsintrafi/v1/accounts/{accountnumber} get call to get account details of a cos account enrolled in sweeps exclude bank/account docid\ vzawbxjbglgavdqddxn8j put/sweepsintrafi/v1/accounts/{accountnumber } put call to exclude specific bank or opt out specific account from sweeps bank list docid\ rzxj8syt4oijdzq0fizz9 get/sweepsintrafi/v1/banks get call to get a list of all banks identify bank docid\ kr8y3fq08pj0 r1hgsr7o get/sweepsintrafi/v1/banks/{banknumber get call to get bank name for a specific bankid related topics webhook events accounts docid\ eas8afqw7m97baezuc8sr tutorials see our api tutorials to learn how to open an account docid\ ztq exumodfi9pu3z10fw create a deposit account open a subledger docid\ xqdrbzh8lzhuqiwzedhoz create a subledger (virtual account) withdraw cd funds early docid\ wdaq0m t5wowktdpxnnk withdraw funds from a certificate of deposit before it reaches maturity