Open account

Relevant webhooks

For this endpoint be sure you have registered for these webhooks:

Core.Account.Opened

Core.Account.Closed

API reference

Creates a deposit account for a specific customer using the customer ID and based on the product ID for that type of account.

Endpoint: /v1/dda/accounts

POST

https://sandbox.crbcos.com/core/v1/dda/accounts

Body Parameters

customerIdstringrequired
Description
The unique ID assigned to a customer when the customer record is created. 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.
productIdstringrequired
Description
ID in GUID format of your specific product type on which the account is based. Provided by Cross River.
titlestringrequired
Description
The name on the account. Usually this is the account holder name, but not always. 255 characters maximum.
statementAddressobjectrequired
Description
Mailing address for paper statement delivery
- street1stringrequired
  Description
  Primary location details of account holder, for instance, street name, house/building number, PO box. 255 character maximum.
- street2string
  Description
  Additional address information. 255 characters maximum.
- street3string
  Description
  Additional address information. 255 characters maximum.
- citystringrequired
  Description
  City full name. 255 characters maximum.
- statestring
  Description
  State name. We recommend you enter the 2-character state code. 255 characters maximum.
- postalCodestringrequired
  Description
  Postal code, also known as ZIP code 50 characters maximum.
- countryCodestringrequired
  Description
  2-letter ISO country code
clientIdentifierstring
Description
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
rateCardstring
Description
ID of the account's assigned, pre-configured interest rate profile, in GUID format

Response

accountNumberstring
Description
Account number of the newly created account
statusstring
Description
Account status: - Inactive - Active - Dormant - Escheat - Closed
accountTypestring
Description
Deposit account type: - GeneralLedger - Deposit - CreditCard - StoredValue - Wallet - Unknown
ledgerTypestring
Description
Ledger type: - Passthrough - Direct
classificationstring
Description
Deposit account classification: - Personal - Business
productTypestring
Description
Product type associated with the deposit account: - GeneralLedger - Checking - Savings - TimeDeposit - MoneyMarket - CreditCard - StoredValue - Wallet - Unknown
closureReasonstring
Description
Reason account was closed
productIdstring
Description
ID in GUID format of your specific product type on which the account is based. Provided by Cross River.
titlestring
Description
The name on the account. Usually this is the account holder name, but not always.
currentBalanceinteger
Description
Current balance. A negative amount means a debit and a positive amount means a credit.
holdAmountinteger
Description
Amount of the hold (if any) placed on the deposit account
transactionCountinteger
Description
Total number of transactions posted to the account
availableBalanceinteger
Description
Available amount of the balance. A negative amount means a debit and a positive amount means a credit.
creditLimitinteger
Description
Credit limit of the account customer
overdraftFundingEnabledboolean
Description
True if overdraft funding is enabled. Otherwise false.
overdraftFundingThresholdinteger
Description
The desired ending balance at the end of each day. If the balance is less, funds are pulled from the funding account.
overdraftFundingAccountNumberstring
Description
Account number of the account used to fund the account if at the end of the day the balance is less than the overdraft funding threshold.
currencystring
Description
Currency held in the account
customerIdstring
Description
The unique ID assigned to a customer when the customer record is created. 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.
statementAddressobject
Description
Mailing address for paper statement delivery
- street1string
  Description
  Primary location details of account holder, for instance, street name, house/building number, PO box.
- street2string
  Description
  Additional address information
- street3string
  Description
  Additional address information
- citystring
  Description
  City full name
- statestring
  Description
  State name. We recommend you enter the 2-character state code.
- postalCodestring
  Description
  Postal code, also known as ZIP code
- countryCodestring
  Description
  2-letter ISO country code
openedAtstring
Description
Date and time the deposit account was opened. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
lastMaintenanceAtstring
Description
Date and time the deposit account last had maintenance performed on it. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
lastContactAtstring
Description
Date and time Cross River last made contact with the deposit account holder. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
lastTransactedAtstring
Description
The date and time a transaction last took place on the deposit account. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
closedAtstring
Description
Date and time the deposit account was closed. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
clientIdentifierstring
Description
Your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
partnerIdstring
Description
Your unique ID in the Cross River system. This ID is in GUID format.
lastModifiedAtstring
Description
Internal Cross River value. Date and time the database entry was last modified. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
rateCardstring
Description
ID of the account's assigned, pre-configured interest rate profile, in GUID format
balancesobject
Description
There can be multiple account balances listed
- accountNumberstring
  Description
  Number of the account this information describes
- isSubAccountboolean
  Description
  If the account balance presented is for a subledger, true. Otherwise false.
- currencystring
  Description
  Currency held in the account
- currentBalanceinteger
  Description
  Balance including all transactions even if they have not yet settled
- availableBalanceinteger
  Description
  Balance available to the account holder
- holdAmountinteger
  Description
  Amount of funds that cannot yet be accessed because the funds are on hold
- transactionCountinteger
  Description
  Number of transactions in the last period
- lastModifiedAtstring
  Description
  Internal Cross River value. Date and time the database entry was last modified. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
- lastTransactedAtstring
  Description
  The date and time a transaction last took place on the account. The date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

curl

curl --location 'https://sandbox.crbcos.com/core/v1/dda/accounts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-key: 025aaf3e-87e5-46e6-ba60-2071c3a69be8' \
--data '{
  "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
  "productId": "83bed086-8182-4151-a1e3-af5b01362783",
  "title": "Jerry Penn",
  "statementAddress": {
    "street1": "12 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "countryCode": "US"
  }
}

'

nodejs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': 'sandbox.crbcos.com',
  'path': '/core/v1/dda/accounts',
  'headers': {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
    'Idempotency-key': '025aaf3e-87e5-46e6-ba60-2071c3a69be8'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
  "productId": "83bed086-8182-4151-a1e3-af5b01362783",
  "title": "Jerry Penn",
  "statementAddress": {
    "street1": "12 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "countryCode": "US"
  }
});

req.write(postData);

req.end();

python

import requests
import json

url = "https://sandbox.crbcos.com/core/v1/dda/accounts"

payload = json.dumps({
  "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
  "productId": "83bed086-8182-4151-a1e3-af5b01362783",
  "title": "Jerry Penn",
  "statementAddress": {
    "street1": "12 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "countryCode": "US"
  }
})
headers = {
  'Authorization': 'Bearer <token>',
  'Content-Type': 'application/json',
  'Idempotency-key': '025aaf3e-87e5-46e6-ba60-2071c3a69be8'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://sandbox.crbcos.com/core/v1/dda/accounts")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request["Idempotency-key"] = "025aaf3e-87e5-46e6-ba60-2071c3a69be8"
request.body = JSON.dump({
  "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
  "productId": "83bed086-8182-4151-a1e3-af5b01362783",
  "title": "Jerry Penn",
  "statementAddress": {
    "street1": "12 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "countryCode": "US"
  }
})

response = https.request(request)
puts response.read_body

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://sandbox.crbcos.com/core/v1/dda/accounts"
  method := "POST"

  payload := strings.NewReader(`{
  "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
  "productId": "83bed086-8182-4151-a1e3-af5b01362783",
  "title": "Jerry Penn",
  "statementAddress": {
    "street1": "12 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "countryCode": "US"
  }
}

`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Idempotency-key", "025aaf3e-87e5-46e6-ba60-2071c3a69be8")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

200

{
    "accountNumber": "2819503463",
    "status": "Active",
    "accountType": "Deposit",
    "ledgerType": "Passthrough",
    "classification": "Personal",
    "productType": "Checking",
    "productId": "83bed086-8182-4151-a1e3-af5b01362783",
    "title": "Jerry Penn",
    "currentBalance": 0,
    "holdAmount": 0,
    "transactionCount": 0,
    "availableBalance": 0,
    "creditLimit": 0,
    "overdraftFundingEnabled": false,
    "overdraftFundingThreshold": 0,
    "currency": "usd",
    "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
    "statementAddress": {
        "street1": "12 Main St",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "countryCode": "US"
    },
    "openedAt": "2025-06-18T09:41:00.9073289-04:00",
    "lastMaintenanceAt": "2025-06-18T09:41:00.9073289-04:00",
    "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
    "lastModifiedAt": "2025-06-18T09:41:00.9073289-04:00"
}