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.

Get started with Cross River APIs.

General account management APIs

This table presents general account management APIs that we describe in detail.

Action

API Call

Description

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

GET /core/v1/dda/accounts/{accountNumber}/tax-documents/

Gets a list of tax documents for a given account, including IDs for each

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.

Time deposit (CD) APIs

This table presents time deposit (CD) APIs that we describe in detail.

Action

API Call

Description

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

GET /core/v1/dda/accounts/{accountNumber}/time-deposit

Returns information about the account activity of a specific time deposit account

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

POST
Request
Response
Body Parameters
customerId
required
String
The unique ID assigned to a customer when the customer record is created (POST /core/v1/cm/customers). You need this ID to take action for a specific customer. For example, when opening an account or adding an address to a customer record. The ID is in GUID format.
productId
required
String
ID in GUID format of your specific product type on which the account is based. Provided by CR.
title
required
String
The name on the account. Usually this is the account holder name, but not always. 255 characters maximum.
statementAddress
required
Object
Mailing address for paper statement delivery
clientIdentifier
optional
String
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
rateCard
optional
String
ID of the account's assigned, pre-configured interest rate profile, in GUID format


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 tax documents by accountNumber
GET
Request
Response
Query Parameters
accountNumber
required
String
Number of the customer's account that earns tax-reportable income
Status
optional
String
Status of the document in the CR system: - Importing - Active - Recalled
documentType
optional
String
Document type the query returns information about: - Form1099Int - Unknown
year
optional
Integer
Year the document covers, in the format YYYY


Get a specific tax document

Gets a specific tax document associated with the account.

Use the Get tax documents 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 foreach account if the earnings of all accounts total $10.00 or more.

Get a PDF of a specific tax document by its document ID
GET
Request
Path Params
accountNumber
required
String
Number of the customer's account that earns tax-reportable income
id
required
String
The document id returned in a GET tax documents query for the specific desired document.


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.

POST
Request
Response
Body Parameters
accountNumber
required
String
ID of the cake to get
waivePenaltyFee
required
Boolean
If true, a request for early withdrawal will be processed without a penalty fee. Otherwise, false.


Get activity on specific CD

Returns information about the account activity of a specific time deposit account.

G
GET
Request
Path Params
accountNumber
required
String
The number of the 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.

GET
Request
Response
Path Params
accountNumber
required
String
Account number of the time deposit account


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

Tutorials

🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.



Updated 25 Sep 2024
Doc contributor
Doc contributor
Doc contributor
Did this page help you?