Accounts

Subledgers

4min

Cross River COS offers the APIs to create subledgers instantly and on-demand. A subledger can be linked to any existing deposit account, also known as the master account.
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 a subledger﻿ 
POST /core/v1/dda/subaccounts
﻿
Creates a new subledger
﻿Get specific subledger information﻿ 
GET /core/v1/dda/subaccounts/{accountNumber}
Returns information on a specific subledger account
Create a subledger
Creates a subledger for the specified Master Account.
POST
Request
Response
Body Parameters
masterAccountNumber
required
String
Master account to open the subledger under
title
required
String
The account title.
255 character limit.
customerId
optional
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.
beneficiary
optional
Object
Beneficiary profile for this subledger
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.
﻿
Get information on a specific subledger
Returns information on a specific subledger account
GET
Request
Response
Path Params
accountNumber
required
String
Sub account number to retrieve
﻿
Associated webhook events
Event Name
Description
Core.SubAccount.Opened
Subledger (subaccount) was opened
Core.SubAccount.Status.Changed
Status of a subledger (subaccount) changed
Core.SubAccount.Closed
Subledger (subaccount) was closed
Core.SubAccount.Title.Changed
Title of subledger (subaccount) changed
﻿

Action	API Call	Description
Create a subledger	POST /core/v1/dda/subaccounts	Creates a new subledger
Get specific subledger information	GET /core/v1/dda/subaccounts/{accountNumber}	Returns information on a specific subledger account

Event Name	Description
Core.SubAccount.Opened	Subledger (subaccount) was opened
Core.SubAccount.Status.Changed	Status of a subledger (subaccount) changed
Core.SubAccount.Closed	Subledger (subaccount) was closed
Core.SubAccount.Title.Changed	Title of subledger (subaccount) changed

🤔

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 15 Oct 2024

Did this page help you?

Error Codes

Card issuing