Subledgers

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 manage subledgers with cross river's apis get api credentials with cross river apis in subledger api endpoints, subledgers are referred to as subaccounts , for example, post /core/v1/dda/subaccounts creates a new subledger once you have access to our sandbox environments you can access these api endpoints in the core module, dda section, through swagger links this table presents the subledger management apis we describe in detail action api call description subledgers /#create a subledger post /core/v1/dda/subaccounts creates a new subledger subledgers /#get information on a specific subledger get /core/v1/dda/subaccounts/{accountnumber} returns information on a specific subledger account create a subledger creates a subledger for the specified master account { "name" "create a subledger ", "method" "post", "url" "/core/v1/dda/subaccounts", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "p9idftsftskm5gwlrp3lq", "language" "curl", "code" "curl request post \\\\\n url https //sandbox crbcos com/core/v1/dda/subaccounts \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" } ], "selectedlanguageid" "p9idftsftskm5gwlrp3lq" }, "results" { "languages" \[ { "id" "vjutubmvyylolejt5wkle", "language" "200", "customlabel" "", "code" "{\n \\"accountnumber\\" \\"string\\",\n \\"accounttype\\" \\"generalledger\\",\n \\"status\\" \\"closed\\",\n \\"ledgertype\\" \\"passthrough\\",\n \\"title\\" \\"string\\",\n \\"currentbalance\\" 0,\n \\"availablebalance\\" 0,\n \\"holdamount\\" 0,\n \\"transactioncount\\" 0,\n \\"openedat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"closedat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"masteraccountnumber\\" \\"string\\",\n \\"beneficiary\\" {\n \\"referenceid\\" \\"string\\",\n \\"firstname\\" \\"string\\",\n \\"middlename\\" \\"string\\",\n \\"lastname\\" \\"string\\",\n \\"entityname\\" \\"string\\",\n \\"streetaddress1\\" \\"string\\",\n \\"streetaddress2\\" \\"string\\",\n \\"city\\" \\"string\\",\n \\"state\\" \\"string\\",\n \\"postalcode\\" \\"string\\",\n \\"countrycode\\" \\"string\\",\n \\"phonenumber\\" \\"string\\",\n \\"emailaddress\\" \\"string\\",\n \\"notes\\" \\"string\\"\n },\n \\"partnerid\\" \\"196295ef 42c7 4de1 bf60 7a5570b12406\\",\n \\"lastmaintenanceat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"lasttransactedat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"productid\\" \\"2010ff28 91cb 4b80 9618 bf018502faf2\\",\n \\"lastmodifiedat\\" \\"2019 01 23t17 20 44 615z\\"\n}" } ], "selectedlanguageid" "vjutubmvyylolejt5wkle" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "masteraccountnumber", "kind" "required", "type" "string", "description" "master account to open the subledger under" }, { "name" "title", "kind" "required", "type" "string", "description" "the account title \n255 character limit ", "children" \[] }, { "name" "customerid", "kind" "optional", "type" "string", "description" "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 \n\nthe id is in guid format ", "children" \[] }, { "name" "beneficiary", "kind" "optional", "type" "object", "description" "beneficiary profile for this subledger", "children" \[ { "name" "referenceid", "kind" "optional", "type" "string", "description" "reference for beneficiary \n50 character limit " }, { "name" "firstname", "kind" "optional", "type" "string", "description" "the first name of the beneficiary \n50 character limit " }, { "name" "lastname", "kind" "optional", "type" "string", "description" "the last name of the beneficiary \n50 character limit" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name of the beneficiary" }, { "name" "entityname", "kind" "optional", "type" "string", "description" "if the beneficiary is a business or organization enter its name if the beneficiary is an individual enter their full name \n255 character limit " }, { "name" "streetaddress1", "kind" "optional", "type" "string", "description" " primary location details of account holder, for instance, street name, house/building number, po box " }, { "name" "streetaddress2", "kind" "optional", "type" "string", "description" "additional address information " }, { "name" "city", "kind" "optional", "type" "string", "description" "city full name " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name we recommend you enter the 2 character state code " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code, also known as zip code" }, { "name" "countrcode", "kind" "optional", "type" "string", "description" "2 letter iso country code" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "the beneficiary phone number" }, { "name" "emailaddress", "kind" "optional", "type" "string", "description" "255 character limit" }, { "name" "notes", "kind" "optional", "type" "string", "description" "general notes about the beneficiary " } ] }, { "name" "clientidentifier", "kind" "optional", "type" "string", "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 ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "accountnumber", "kind" "optional", "type" "string", "description" "the subledger account number" }, { "name" "accounttype", "kind" "optional", "type" "string", "description" "deposit account type\ checkingsavingsgeneralledgerloan", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "account status \n\n inactive\n active\n dormant\n escheat\n closed\n chargeoff", "children" \[] }, { "name" "ledgertype", "kind" "optional", "type" "string", "description" "ledger type\ passthroughdirect", "children" \[] }, { "name" "title", "kind" "optional", "type" "string", "description" "the name on the account usually this is the account holder name, but not always ", "children" \[] }, { "name" "currentbalance", "kind" "optional", "type" "integer", "description" "current balance a negative amount means a debit and a positive amount means a credit ", "children" \[] }, { "name" "availablebalance", "kind" "optional", "type" "integer", "description" "available amount of the balance a negative amount means a debit and a positive amount means a credit ", "children" \[] }, { "name" "holdamount", "kind" "optional", "type" "integer", "description" "amount of the hold (if any) placed on the account", "children" \[] }, { "name" "transactioncount", "kind" "optional", "type" "integer", "description" "total number of transactions posted to the account", "children" \[] }, { "name" "openedat", "kind" "optional", "type" "string", "description" "date and time the deposit account was opened the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "closedat", "kind" "optional", "type" "string", "description" "the date and time that the account was closed", "children" \[] }, { "name" "masteraccountnumber", "kind" "optional", "type" "string", "description" "master account the subledger was opened under", "children" \[] }, { "name" "beneficiary", "kind" "optional", "type" "object", "description" "beneficiary profile for this subledger", "children" \[ { "name" "referenceid", "kind" "optional", "type" "string", "description" "reference for beneficiary \n50 character limit " }, { "name" "firstname", "kind" "optional", "type" "string", "description" "the first name of the beneficiary \n50 character limit " }, { "name" "lastname", "kind" "optional", "type" "string", "description" "the last name of the beneficiary \n50 character limit" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name of the beneficiary" }, { "name" "entityname", "kind" "optional", "type" "string", "description" "if the beneficiary is a business or organization enter its name if the beneficiary is an individual enter their full name \n255 character limit " }, { "name" "streeetaddress1", "kind" "optional", "type" "string", "description" "primary location details of account holder, for instance, street name, house/building number, po box " }, { "name" "streeetaddress2", "kind" "optional", "type" "string", "description" "additional address information " }, { "name" "city", "kind" "optional", "type" "string", "description" "city full name " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name we recommend you enter the 2 character state code " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code, also known as zip code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "2 letter iso country code" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "the beneficiary phone number" }, { "name" "emailaddress", "kind" "optional", "type" "string", "description" "255 character limit" }, { "name" "notes", "kind" "optional", "type" "string", "description" "general notes about the beneficiary " } ] }, { "name" "notes", "kind" "optional", "type" "string", "description" "general notes about the beneficiary", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "cos id of the partner associated with the account", "children" \[] }, { "name" "lastmaintenancedat", "kind" "optional", "type" "string", "description" "date and time the account was last modified", "children" \[] }, { "name" "lasttransactedat", "kind" "optional", "type" "string", "description" "the date and time a transaction last took place on the account", "children" \[] }, { "name" "productid", "kind" "optional", "type" "string", "description" "the cos id of the product associated with the account", "children" \[] } ] } get information on a specific subledger returns information on a specific subledger account { "name" "get information on a specific subledger ", "method" "get", "url" "/core/v1/dda/subaccounts/{accountnumber}", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "csk74uz1d9pf5ce3jduzf", "language" "curl", "code" "curl request get \\\\\n url https //sandbox crbcos com/core/v1/dda/subaccounts \\\\\n header 'accept application/json'", "customlabel" "" } ], "selectedlanguageid" "csk74uz1d9pf5ce3jduzf" }, "results" { "languages" \[ { "id" "wk6fz9yqqet2djskuk3xj", "language" "200", "customlabel" "", "code" "{\n \\"accountnumber\\" \\"string\\",\n \\"accounttype\\" \\"generalledger\\",\n \\"status\\" \\"closed\\",\n \\"ledgertype\\" \\"passthrough\\",\n \\"title\\" \\"string\\",\n \\"currentbalance\\" 0,\n \\"availablebalance\\" 0,\n \\"holdamount\\" 0,\n \\"transactioncount\\" 0,\n \\"openedat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"closedat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"masteraccountnumber\\" \\"string\\",\n \\"beneficiary\\" {\n \\"referenceid\\" \\"string\\",\n \\"firstname\\" \\"string\\",\n \\"middlename\\" \\"string\\",\n \\"lastname\\" \\"string\\",\n \\"entityname\\" \\"string\\",\n \\"streetaddress1\\" \\"string\\",\n \\"streetaddress2\\" \\"string\\",\n \\"city\\" \\"string\\",\n \\"state\\" \\"string\\",\n \\"postalcode\\" \\"string\\",\n \\"countrycode\\" \\"string\\",\n \\"phonenumber\\" \\"string\\",\n \\"emailaddress\\" \\"string\\",\n \\"notes\\" \\"string\\"\n },\n \\"partnerid\\" \\"00000000 0000 0000 0000 000000000000\\",\n \\"lastmaintenanceat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"lasttransactedat\\" \\"2019 01 23t17 20 44 615z\\",\n \\"productid\\" \\"00000000 0000 0000 0000 000000000000\\",\n \\"lastmodifiedat\\" \\"2019 01 23t17 20 44 615z\\"\n}" } ], "selectedlanguageid" "wk6fz9yqqet2djskuk3xj" }, "request" { "pathparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "sub account number to retrieve", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "response" \[ { "name" "accountnumber", "kind" "optional", "type" "string", "description" "the subledger account number" }, { "name" "accounttype", "kind" "optional", "type" "string", "description" "deposit account type\ checkingsavingsgeneralledgerloan", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "account status inactiveactivedormantescheatclosedchargeoff", "children" \[] }, { "name" "ledgertype", "kind" "optional", "type" "string", "description" "ledger type\ passthroughdirect", "children" \[] }, { "name" "title", "kind" "optional", "type" "string", "description" "the name on the account usually this is the account holder name, but not always ", "children" \[] }, { "name" "currentbalance", "kind" "optional", "type" "integer", "description" "the account's current balance ", "children" \[] }, { "name" "availablebalance", "kind" "optional", "type" "integer", "description" "current balance a negative amount means a debit and a positive amount means a credit ", "children" \[] }, { "name" "holdamount", "kind" "optional", "type" "integer", "description" "amount of the hold (if any) placed on the deposit account", "children" \[] }, { "name" "transactioncount", "kind" "optional", "type" "integer", "description" "total number of transactions posted to the account", "children" \[] }, { "name" "openedat", "kind" "optional", "type" "string", "description" "date and time the deposit account was opened the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "closedat", "kind" "optional", "type" "string", "description" "the date and time that the account was closed", "children" \[] }, { "name" "masteraccountnumber", "kind" "optional", "type" "string", "description" "master account the subledger was opened under ", "children" \[] }, { "name" "beneficiary", "kind" "optional", "type" "object", "description" "beneficiary profile for this subledger", "children" \[ { "name" "referenceid", "kind" "optional", "type" "string", "description" "reference for beneficiary \n50 character limit " }, { "name" "firstname", "kind" "optional", "type" "string", "description" "the first name of the beneficiary \n50 character limit " }, { "name" "lastname", "kind" "optional", "type" "string", "description" "the last name of the beneficiary \n50 character limit" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name of the beneficiary" }, { "name" "entityname", "kind" "optional", "type" "string", "description" "if the beneficiary is a business or organization enter its name if the beneficiary is an individual enter their full name \n255 character limit " }, { "name" "streetaddress1", "kind" "optional", "type" "string", "description" " primary location details of account holder, for instance, street name, house/building number, po box " }, { "name" "streetaddress2", "kind" "optional", "type" "string", "description" "additional address information " }, { "name" "city", "kind" "optional", "type" "string", "description" "city full name " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name we recommend you enter the 2 character state code " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code, also known as zip code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "2 letter iso country code" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "the beneficiary phone number" }, { "name" "emailaddress", "kind" "optional", "type" "string", "description" "255 character limit" }, { "name" "notes", "kind" "optional", "type" "string", "description" "general notes about the beneficiary " } ] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "cos id of the partner associated with the account ", "children" \[] }, { "name" "lastmaintenancedat", "kind" "optional", "type" "string", "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]", "children" \[] }, { "name" "lasttransactedat", "kind" "optional", "type" "string", "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]", "children" \[] }, { "name" "productid", "kind" "optional", "type" "string", "description" "id in guid format of your specific product type on which the account is based provided by cr ", "children" \[] } ] }