Accounts

Account management

16min
cross river cos provides multiple apis for managing various types of accounts account management apis are found in the core module of our cos sandbox, in the dda section register with cross river apis general account management apis this table presents general account management apis that we describe in detail action api call description account management docid\ yzz6gp6w98rudtrapzpov post /core/v1/dda/accounts creates a dda account based on the product id for that type of account this includes dda and cd (time deposit) accounts associated webhook events core account opened account management docid\ yzz6gp6w98rudtrapzpov get /core/v1/dda/accounts/{accountnumber}/tax documents/ gets a list of tax documents for a given account, including ids for each account management docid\ yzz6gp6w98rudtrapzpov get /core/v1/dda/accounts/{accountnumber}/tax documents/{id} retrieves a pdf of a specific tax document closed accounts can only be re opened by the cr ops teams to re open an account please open a support ticket https //crossriver service now\ com/csm?id=cos sandbox request form\&sys id=713de878c300b5105d3eafdc7a013184\&sysparm category=df09f2623310c2906b697d934d5c7b4a time deposit (cd) apis this table presents time deposit (cd) apis that we describe in detail action api call description account management docid\ yzz6gp6w98rudtrapzpov 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 request bump up of cd to higher interest rate post /core/v1/dda/accounts/{accountnumber}/time deposit/bump up not currently offered account management docid\ yzz6gp6w98rudtrapzpov get /core/v1/dda/accounts/{accountnumber}/time deposit returns information about the account activity of a specific time deposit account account management docid\ yzz6gp6w98rudtrapzpov 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 open a deposit account creates a deposit account based on the product id for that type of account request attributes get tax documents returns a list of the tax documents associated with a specified account based on query criteria the list includes each document's unique id, which you need to pull a specific document the response values below are repeated for each document in the list once you have the document id use get /core/v1/dda/accounts/{accountnumber}/tax documents/{id} to pull an individual document important only pull documents as needed if you want to pull a large number of documents, speak to your relationship manager the irs requires cross river to provide account holders with an irs form 1099 for earnings equal to or greater than $10 00, per taxpayer identification number (tin) should the customer have more than one account, the system generates a 1099 for each account if the earnings of all accounts total $10 00 or more add query parameters to filter the response the api returns to all get calls use pagination to control presentation of your results get a specific tax document gets a specific tax document associated with the account use the account management docid\ yzz6gp6w98rudtrapzpov endpoint to find out the document ids this call returns a pdf of the specified tax document important only pull documents as needed if you want to pull a large number of documents, speak to your relationship manager the irs requires cross river to provide account holders with an irs form 1099 for earnings equal to or greater than $10 00, per taxpayer identification number (tin) should the customer have more than one account, the system generates a 1099 for each account if the earnings of all accounts total $10 00 or more response attributes the system responds with a pdf of the specific tax document for display in your app withdraw funds early from a cd requests to withdraw the funds from a time deposit (cd) account before the account reaches maturity depending on the setting of the waivepenaltyfee attribute, the penalty fee is either waived or not if the penalty fee for early withdrawal is waived, it is as if the account owner performs a partial withdrawal of funds actual withdrawal of the funds requires a transaction call money amounts in api calls and responses are written without a decimal point between the dollars and the cents get activity on specific cd returns information about the account activity of a specific time deposit account response attributes the response attributes for this call are the same as for request early withdrawal of time deposit get cd penalty fee value returns the penalty fee if you make an early withdrawal to an active time deposit account the response will define the number of months during which a penalty will usually be applied on early withdrawal ( months ), and the number of days of interest to be paid in penalty ( feedays ) money amounts in api calls and responses are written without a decimal point between the dollars and the cents associated webhook events event name description core account opened a new account was opened core account status changed status of an account changed core account closed account was closed core account title changed account title changed core account settled account settled core account balance changed indicates account balance fluctuations core relationship added relationship was added to the account core relationship removed relationship was removed from the account core restriction placed restriction was placed on the account core restriction removed restriction was removed for the account core fee assessed account fee is under consideration core fee waived account fee was waived core interest accrued account interest accrued core interest paid account interest paid core stoppayment placed stop payment placed on the account core stoppayment removed stop payment removed from the account core regdpolicy violated reg d was violated on a savings account core transaction completed transaction completed successfully core transaction rejected transaction was rejected on account core activity posted activity was posted to the account core memopost created memo post was created on the account core memopost changed memo post was changed core memopost removed memo post was removed core hold placed hold placed on the account core hold changed hold status has changed core hold removed hold was removed from the account related topics account management interest rate cards error codes tutorials open a deposit account early withdrawal from a cd