Accounts
Account mgmt APIs
Open account
1 min
{ "name" "endpoint /v1/dda/accounts", "method" "post", "url" "https //sandbox crbcos com/core/v1/dda/accounts", "description" "creates a deposit account based on the product id for that type of account ", "tab" "examples", "examples" { "languages" \[ { "id" "tkkprjvwm9o a0jz7ux6d", "language" "curl", "code" "curl location 'https //sandbox crbcos com/core/v1/dda/accounts' \\\\\n header 'idempotency key 025aaf3e 87e5 46e6 ba60 2071c3a69be8' \\\\\n header 'content type application/json' \\\\\n header 'authorization bearer \<token>' \\\\\n data '{\n \\"customerid\\" \\"53c34cf0 4cd2 4768 937b b30000dffdca\\",\n \\"productid\\" \\"83bed086 8182 4151 a1e3 af5b01362783\\",\n \\"title\\" \\"jerry penn\\",\n \\"statementaddress\\" {\n \\"street1\\" \\"12 main st\\",\n \\"city\\" \\"new york\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n }\n}\n\n'", "customlabel" "" }, { "id" "xh3covfbxlwqz4cv9gdvv", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'post',\n 'hostname' 'sandbox crbcos com',\n 'path' '/core/v1/dda/accounts',\n 'headers' {\n 'idempotency key' '025aaf3e 87e5 46e6 ba60 2071c3a69be8',\n 'content type' 'application/json',\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\nvar postdata = json stringify({\n \\"customerid\\" \\"53c34cf0 4cd2 4768 937b b30000dffdca\\",\n \\"productid\\" \\"83bed086 8182 4151 a1e3 af5b01362783\\",\n \\"title\\" \\"jerry penn\\",\n \\"statementaddress\\" {\n \\"street1\\" \\"12 main st\\",\n \\"city\\" \\"new york\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n }\n});\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "aevc5e2js9ddxzs22o3fb", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //sandbox crbcos com/core/v1/dda/accounts\\"\n\npayload = json dumps({\n \\"customerid\\" \\"53c34cf0 4cd2 4768 937b b30000dffdca\\",\n \\"productid\\" \\"83bed086 8182 4151 a1e3 af5b01362783\\",\n \\"title\\" \\"jerry penn\\",\n \\"statementaddress\\" {\n \\"street1\\" \\"12 main st\\",\n \\"city\\" \\"new york\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n }\n})\nheaders = {\n 'idempotency key' '025aaf3e 87e5 46e6 ba60 2071c3a69be8',\n 'content type' 'application/json',\n 'authorization' 'bearer \<token>'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "xlslcd0kywmtilqmtxpl1", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/core/v1/dda/accounts\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"idempotency key\\"] = \\"025aaf3e 87e5 46e6 ba60 2071c3a69be8\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"authorization\\"] = \\"bearer \<token>\\"\nrequest body = json dump({\n \\"customerid\\" \\"53c34cf0 4cd2 4768 937b b30000dffdca\\",\n \\"productid\\" \\"83bed086 8182 4151 a1e3 af5b01362783\\",\n \\"title\\" \\"jerry penn\\",\n \\"statementaddress\\" {\n \\"street1\\" \\"12 main st\\",\n \\"city\\" \\"new york\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n }\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "yg ditew4xv27munmwjzc", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"strings\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //sandbox crbcos com/core/v1/dda/accounts\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"customerid\\" \\"53c34cf0 4cd2 4768 937b b30000dffdca\\",`+\\"\n\\"+`\n \\"productid\\" \\"83bed086 8182 4151 a1e3 af5b01362783\\",`+\\"\n\\"+`\n \\"title\\" \\"jerry penn\\",`+\\"\n\\"+`\n \\"statementaddress\\" {`+\\"\n\\"+`\n \\"street1\\" \\"12 main st\\",`+\\"\n\\"+`\n \\"city\\" \\"new york\\",`+\\"\n\\"+`\n \\"state\\" \\"ny\\",`+\\"\n\\"+`\n \\"postalcode\\" \\"10001\\",`+\\"\n\\"+`\n \\"countrycode\\" \\"us\\"`+\\"\n\\"+`\n }`+\\"\n\\"+`\n}`+\\"\n\\"+`\n`+\\"\n\\"+`\n`)\n\n client = \&http client {\n }\n req, err = http newrequest(method, url, payload)\n\n if err != nil {\n fmt println(err)\n return\n }\n req header add(\\"idempotency key\\", \\"025aaf3e 87e5 46e6 ba60 2071c3a69be8\\")\n req header add(\\"content type\\", \\"application/json\\")\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" "tkkprjvwm9o a0jz7ux6d" }, "results" { "languages" \[ { "id" "g99c9siitand8yqgyvokr", "language" "200", "customlabel" "", "code" "{\n \\"accountnumber\\" \\"2819503463\\",\n \\"status\\" \\"active\\",\n \\"accounttype\\" \\"deposit\\",\n \\"ledgertype\\" \\"passthrough\\",\n \\"classification\\" \\"personal\\",\n \\"producttype\\" \\"checking\\",\n \\"productid\\" \\"83bed086 8182 4151 a1e3 af5b01362783\\",\n \\"title\\" \\"jerry penn\\",\n \\"currentbalance\\" 0,\n \\"holdamount\\" 0,\n \\"transactioncount\\" 0,\n \\"availablebalance\\" 0,\n \\"creditlimit\\" 0,\n \\"overdraftfundingenabled\\" false,\n \\"overdraftfundingthreshold\\" 0,\n \\"currency\\" \\"usd\\",\n \\"customerid\\" \\"53c34cf0 4cd2 4768 937b b30000dffdca\\",\n \\"statementaddress\\" {\n \\"street1\\" \\"12 main st\\",\n \\"city\\" \\"new york\\",\n \\"state\\" \\"ny\\",\n \\"postalcode\\" \\"10001\\",\n \\"countrycode\\" \\"us\\"\n },\n \\"openedat\\" \\"2025 06 18t09 41 00 9073289 04 00\\",\n \\"lastmaintenanceat\\" \\"2025 06 18t09 41 00 9073289 04 00\\",\n \\"partnerid\\" \\"cd9c12f4 7691 424a b38b af5b0134c611\\",\n \\"lastmodifiedat\\" \\"2025 06 18t09 41 00 9073289 04 00\\"\n}" } ], "selectedlanguageid" "g99c9siitand8yqgyvokr" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "customerid", "kind" "required", "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 \nthe id is in guid format ", "" "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 \nthe id is in guid format " }, { "name" "productid", "kind" "required", "type" "string", "description" "id in guid format of your specific product type on which the account is based provided by cross river ", "" "id in guid format of your specific product type on which the account is based provided by cross river " }, { "name" "title", "kind" "required", "type" "string", "description" "the name on the account usually this is the account holder name, but not always \n255 characters maximum ", "" "the name on the account usually this is the account holder name, but not always \n255 characters maximum " }, { "name" "statementaddress", "kind" "required", "type" "object", "description" "mailing address for paper statement delivery", "children" \[ { "name" "street1", "kind" "required", "type" "string", "description" "primary location details of account holder, for instance, street name, house/building number, po box \n255 character maximum " }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional address information \n255 characters maximum " }, { "name" "street3", "kind" "optional", "type" "string", "description" "additional address information \n255 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "city full name \n255 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name we recommend you enter the 2 character state code \n255 characters maximum " }, { "name" "postalcode", "kind" "required", "type" "string", "description" "postal code, also known as zip code\n50 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ], "schema" \[ { "name" "street1", "kind" "required", "type" "string", "description" "primary location details of account holder, for instance, street name, house/building number, po box \n255 character maximum " }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional address information \n255 characters maximum " }, { "name" "street3", "kind" "optional", "type" "string", "description" "additional address information \n255 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "city full name \n255 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name we recommend you enter the 2 character state code \n255 characters maximum " }, { "name" "postalcode", "kind" "required", "type" "string", "description" "postal code, also known as zip code\n50 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "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" \[] }, { "name" "ratecard", "kind" "optional", "type" "string", "description" "id of the account's assigned, pre configured interest rate profile, in guid format", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number of the newly created account" }, { "name" "status", "kind" "optional", "type" "string", "description" "account status \n inactive\n active\n dormant\n escheat\n closed", "children" \[] }, { "name" "accounttype", "kind" "optional", "type" "string", "description" "deposit account type \n generalledger\n deposit\n creditcard\n storedvalue\n wallet\n unknown", "children" \[] }, { "name" "ledgertype", "kind" "optional", "type" "string", "description" "ledger type \n passthrough\n direct", "children" \[] }, { "name" "classification", "kind" "optional", "type" "string", "description" "deposit account classification \n personal\n business", "children" \[] }, { "name" "producttype", "kind" "optional", "type" "string", "description" "product type associated with the deposit account \n generalledger\n checking\n savings\n timedeposit\n moneymarket\n creditcard\n storedvalue\n wallet\n unknown", "children" \[] }, { "name" "closurereason", "kind" "optional", "type" "string", "description" "reason account was closed", "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" "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" "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" "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" "creditlimit", "kind" "optional", "type" "integer", "description" "credit limit of the account customer", "children" \[] }, { "name" "overdraftfundingenabled", "kind" "optional", "type" "boolean", "description" "true if overdraft funding is enabled otherwise false ", "children" \[] }, { "name" "overdraftfundingthreshold", "kind" "optional", "type" "integer", "description" "the desired ending balance at the end of each day if the balance is less, funds are pulled from the funding account ", "children" \[] }, { "name" "overdraftfundingaccountnumber", "kind" "optional", "type" "string", "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 ", "children" \[] }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency held in the account", "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" "statementaddress", "kind" "optional", "type" "object", "description" "mailing address for paper statement delivery", "children" \[ { "name" "street1", "kind" "optional", "type" "string", "description" "primary location details of account holder, for instance, street name, house/building number, po box " }, { "name" "street2", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "street3", "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" "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" "lastmaintenanceat", "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" "lastcontactat", "kind" "optional", "type" "string", "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]", "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" "closedat", "kind" "optional", "type" "string", "description" "date and time the deposit account was closed the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "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" "partnerid", "kind" "optional", "type" "string", "description" "your id in the cross river system ", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified ", "children" \[] }, { "name" "ratecard", "kind" "optional", "type" "string", "description" "id of the account's assigned, pre configured interest rate profile, in guid format", "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]" } ] } ] }