--- title: Accounts slug: apis/accounts description: Manage deposit accounts, subledgers, and time deposits; supports opening, retrieving, and managing accounts and related documents. docTags: createdAt: 2025-04-10T11:13:24.396Z --- :::CtaButton{label="Accounts concepts" docId="ZQyAf4oeI1rEzpBOI78MJ" openInNewTab="true"} ::: ## Accounts APIs Cross River offers a set of APIs for account management in our banking core. :::hint{type="info"} [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. :::hint{type="warning"} **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 | | [Change subledger title](docId\:vF6EET959sod8TW1orGD8) | `PUT /core/v1/dda/subaccounts/{accountNumber}/title` | Changes the title on a specific subledger account | | [Change subledger customer](docId\:wfjZEWfzQXnkXCWxsVcm5) | `PUT /core/v1/dda/subaccounts/{accountNumber}/customer` | Changes the customer associated with the subledger account | | [Close subledger](docId\:KKcIiiesDAtwh3dOzrMPW) | `GET /core/v1/dda/subaccounts/{accountNumber}` | Close a 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.