Accounts
Subledgers APIs
Subledger info
1 min
{ "name" "endpoint /core/v1/dda/subaccounts/{accountnumber}", "method" "get", "url" " https //sandbox crbcos com/core/v1/dda/subaccounts/{accountnumber}", "description" "returns information on a specific subledger account", "tab" "examples", "examples" { "languages" \[ { "id" "p9idftsftskm5gwlrp3lq", "language" "curl", "code" "curl location 'https //sandbox crbcos com/core/v1/dda/subaccounts/302022615264' \\\\\n header 'authorization bearer \<token>'", "customlabel" "" }, { "id" "sjz6scuddiyhuazx4c86k", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'get',\n 'hostname' 'sandbox crbcos com',\n 'path' '/core/v1/dda/subaccounts/302022615264',\n 'headers' {\n 'authorization' 'bearer \<token>'\n },\n 'maxredirects' 20\n};\n\nvar req = https request(options, function (res) {\n var chunks = \[];\n\n res on(\\"data\\", function (chunk) {\n chunks push(chunk);\n });\n\n res on(\\"end\\", function (chunk) {\n var body = buffer concat(chunks);\n console log(body tostring());\n });\n\n res on(\\"error\\", function (error) {\n console error(error);\n });\n});\n\nreq end();", "customlabel" "" }, { "id" "gdb p0o6t95gp ehqfwx2", "language" "python", "code" "import http client\n\nconn = http client httpsconnection(\\"sandbox crbcos com\\")\npayload = ''\nheaders = {\n 'authorization' 'bearer \<token>'\n}\nconn request(\\"get\\", \\"/core/v1/dda/subaccounts/302022615264\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "customlabel" "" }, { "id" "fxvcnwdedvwga2rua43lj", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/core/v1/dda/subaccounts/302022615264\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"authorization\\"] = \\"bearer \<token>\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "u9brpgyscj1siildwem6d", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //sandbox crbcos com/core/v1/dda/subaccounts/302022615264\\"\n method = \\"get\\"\n\n client = \&http client {\n }\n req, err = http newrequest(method, url, nil)\n\n if err != nil {\n fmt println(err)\n return\n }\n req header add(\\"authorization\\", \\"bearer \<token>\\")\n\n res, err = client do(req)\n if err != nil {\n fmt println(err)\n return\n }\n defer res body close()\n\n body, err = io readall(res body)\n if err != nil {\n fmt println(err)\n return\n }\n fmt println(string(body))\n}", "customlabel" "" } ], "selectedlanguageid" "p9idftsftskm5gwlrp3lq" }, "results" { "languages" \[ { "id" "vjutubmvyylolejt5wkle", "language" "200", "customlabel" "", "code" "{\n \\"accountnumber\\" \\"302022615264\\",\n \\"accounttype\\" \\"deposit\\",\n \\"status\\" \\"active\\",\n \\"ledgertype\\" \\"passthrough\\",\n \\"producttype\\" \\"checking\\",\n \\"title\\" \\"jerry penn\\",\n \\"currentbalance\\" 0,\n \\"availablebalance\\" 0,\n \\"holdamount\\" 0,\n \\"transactioncount\\" 0,\n \\"creditlimit\\" 0,\n \\"currency\\" \\"usd\\",\n \\"openedat\\" \\"2025 06 24t03 05 04 797 04 00\\",\n \\"masteraccountnumber\\" \\"2819503463\\",\n \\"customerid\\" \\"53c34cf0 4cd2 4768 937b b30000dffdca\\",\n \\"beneficiary\\" {\n \\"firstname\\" \\"jerry\\",\n \\"lastname\\" \\"penn\\",\n \\"streetaddress1\\" \\"12 main st\\",\n \\"city\\" \\"new york\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n },\n \\"partnerid\\" \\"cd9c12f4 7691 424a b38b af5b0134c611\\",\n \\"lastmaintenanceat\\" \\"2025 06 24t03 05 04 797 04 00\\",\n \\"productid\\" \\"83bed086 8182 4151 a1e3 af5b01362783\\",\n \\"lastmodifiedat\\" \\"2025 06 24t03 05 04 8043224 04 00\\"\n}" } ], "selectedlanguageid" "vjutubmvyylolejt5wkle" }, "request" { "pathparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "account number for the subaccount (subledger) you want to to retrieve information about", "" "account number for the subaccount (subledger) you want to to retrieve information about" } ], "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 \n generalledger\n deposit\n creditcard\n storedvalue\n wallet\n unknown", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "subledger account status \n closed\n active", "children" \[] }, { "name" "ledgertype", "kind" "optional", "type" "string", "description" "ledger type \n passthrough\n direct", "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" "creditlimit", "kind" "optional", "type" "integer", "description" "credit limit of the account customer", "children" \[] }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency held in 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 the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "masteraccountnumber", "kind" "optional", "type" "string", "description" "master account the subledger was opened under", "children" \[] }, { "name" "customerid", "kind" "optional", "type" "string", "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 ", "children" \[] }, { "name" "beneficiary", "kind" "optional", "type" "object", "description" "beneficiary profile for this subledger", "children" \[ { "name" "referenceid", "kind" "optional", "type" "string", "description" "reference for beneficiary" }, { "name" "firstname", "kind" "optional", "type" "string", "description" "the first name of the beneficiary" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name of the beneficiary" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "the last 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 " }, { "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" "beneficiary email address 255 character limit " }, { "name" "notes", "kind" "optional", "type" "string", "description" "general notes about the beneficiary" }, { "name" "taxidtype", "kind" "optional", "type" "string", "description" " ssn\n ein\n itin\n vat\n foreign" }, { "name" "taxid", "kind" "optional", "type" "string", "description" "benficiary tax id number" }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "beneficiary birthdate in the format yyyy mm dd" }, { "name" "dateformed", "kind" "optional", "type" "string", "description" "date the subledger was formed, in the format yyyy mm dd" } ] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your id in the cr system this id is in guid format ", "children" \[] }, { "name" "lastmaintenanceat", "kind" "optional", "type" "string", "description" "date and time the 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 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 cross river ", "children" \[] }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes ", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified ", "children" \[] }, { "name" "balances", "kind" "optional", "type" "object", "description" "there can be multiple account balances listed", "children" \[ { "name" "accountnumber", "kind" "optional", "type" "string", "description" "number of the account this information describes" }, { "name" "issubaccount", "kind" "optional", "type" "boolean", "description" "if the account balance presented is for a subledger, true otherwise false " }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency held in the account" }, { "name" "currentbalance", "kind" "optional", "type" "integer", "description" "balance including all transactions even if they have not yet settled" }, { "name" "availablebalance", "kind" "optional", "type" "integer", "description" "balance available to the account holder" }, { "name" "holdamount", "kind" "optional", "type" "integer", "description" "amount of funds that cannot yet be accessed because the funds are on hold" }, { "name" "transactioncount", "kind" "optional", "type" "integer", "description" "number of transactions in the last period" }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "lasttransactedat", "kind" "optional", "type" "string", "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]" } ] } ] }