Accounts
Deposit sweeps APIs
Exclude bank/account
1 min
{ "name" "endpoint sweepsintrafi/v1/accounts/{accountnumber}", "method" "put", "url" "https //sandbox crbcos com/sweepsintrafi/v1/accounts/{accountnumber}", "description" "use this call to \nexclude banks from the sweep network\nyour customers may already have funds at a certain bank and this is a way to exclude that bank \nopt out of sweeps when a product is enabled for sweeps, all accounts created from that product are enrolled into the sweeps program use this endpoint to mark an account inactive for sweeps, effectively opting out for sweeps ", "tab" "examples", "examples" { "languages" \[ { "id" "ckbecle8ipdxerwfge2bm", "language" "curl", "code" "curl location request put 'https //sandbox crbcos com/sweepsintrafi/v1/accounts/2666129453'\n header 'content type application/json'\n header 'authorization bearer \<token>'\n data '{\n \\"status\\" \\"active\\",\n \\"bankexclusions\\" \[ \n \\"30895\\",\n \\"10015\\"\n ]\n} '", "customlabel" "" }, { "id" "eqmgrbptniivt7xlo1spd", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'put',\n 'hostname' 'sandbox crbcos com',\n 'path' '/sweepsintrafi/v1/accounts/2666129453',\n 'headers' {\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 \\"status\\" \\"active\\",\n \\"bankexclusions\\" \[\n \\"30895\\",\n \\"10015\\"\n ]\n});\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "34xkfva9q2ihw0pfypk4x", "language" "python", "code" "import http client\nimport json\n\nconn = http client httpsconnection(\\"sandbox crbcos com\\")\npayload = json dumps({\n \\"status\\" \\"active\\",\n \\"bankexclusions\\" \[\n \\"30895\\",\n \\"10015\\"\n ]\n})\nheaders = {\n 'content type' 'application/json',\n 'authorization' 'bearer \<token>'\n}\nconn request(\\"put\\", \\"/sweepsintrafi/v1/accounts/2666129453\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "customlabel" "" }, { "id" "r6r6yx1wvvmybmscyjvxp", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/sweepsintrafi/v1/accounts/2666129453\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest\[\\"authorization\\"] = \\"bearer \<token>\\"\nrequest body = json dump({\n \\"status\\" \\"active\\",\n \\"bankexclusions\\" \[\n \\"30895\\",\n \\"10015\\"\n ]\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "7xtp2y0nvmuywqwerzmhr", "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/sweepsintrafi/v1/accounts/2666129453\\"\n method = \\"put\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"status\\" \\"active\\",`+\\"\n\\"+`\n \\"bankexclusions\\" \[ `+\\"\n\\"+`\n \\"30895\\",`+\\"\n\\"+`\n \\"10015\\"`+\\"\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(\\"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" "ckbecle8ipdxerwfge2bm" }, "results" { "languages" \[ { "id" "qqhilt fhhpgn7vzgszaq", "language" "200", "customlabel" "", "code" "{\n \\"accountnumber\\" \\"2666129453\\",\n \\"status\\" \\"active\\",\n \\"title\\" \\"sweeps test 2\\",\n \\"bankexclusions\\" \[\n \\"30895\\",\n \\"10015\\"\n ],\n \\"corebalance\\" 125627321,\n \\"corebalanceasof\\" \\"2024 09 25t16 17 20 1 04 00\\",\n \\"custodialbalance\\" 25627321,\n \\"networkbalance\\" 100000000,\n \\"networkbalanceasof\\" \\"2024 09 24t16 33 43 613 04 00\\",\n \\"maxsweepamount\\" 0,\n \\"productid\\" \\"e4404005 03c1 4710 b759 b13700ebfac4\\",\n \\"partnerid\\" \\"6e6769ec 99e0 4c4f 8ae8 b13700eab0fc\\",\n \\"openedat\\" \\"2024 05 14t16 26 10 227 04 00\\",\n \\"lastmodifiedat\\" \\"2024 09 25t16 18 48 5446146 04 00\\",\n \\"productname\\" \\"ibs checking product\\",\n \\"partnername\\" \\"ibrahim saeed partner\\"\n}" }, { "id" "mkzojj1rxmgrswjeoosvn", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}" } ], "selectedlanguageid" "qqhilt fhhpgn7vzgszaq" }, "request" { "pathparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "account number of account you want to make changes to", "" "required" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "status", "kind" "required", "type" "string", "description" "set to \\"active\\" to enroll this account in the sweeps program \nset to \\"inactive\\" to opt this account out of the sweeps program " }, { "name" "bankexclusions", "kind" "optional", "type" "string", "description" "bank ids of banks to excluded from the network of banks where your funds may be swept to ", "" "bank ids of banks to excluded from the network of banks where your funds may be swept to " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number" }, { "name" "status", "kind" "optional", "type" "string", "description" "inactive or active", "children" \[] }, { "name" "title", "kind" "optional", "type" "string", "description" "the name on the account usually this is the account holder name, but not always \n255 characters maximum ", "children" \[] }, { "name" "bankexclusions", "kind" "optional", "type" "array", "description" "bank ids of banks to excluded from the network of banks where your funds may be swept to ", "children" \[] }, { "name" "corebalance", "kind" "optional", "type" "string", "description" "total available balance at cross river", "children" \[] }, { "name" "corebalanceasof", "kind" "optional", "type" "string", "description" "date and time of the core balance in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "custodialbalance", "kind" "optional", "type" "integer", "description" "total amount held at cross river", "children" \[] }, { "name" "networkbalance", "kind" "optional", "type" "integer", "description" "total amount swept to intrafi ", "children" \[] }, { "name" "networkbalanceasof", "kind" "optional", "type" "string", "description" "date and time of the network balance in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "maxsweepamount", "kind" "optional", "type" "integer", "description" "max sweep amount will always be 0 as it refers to an override program sweep limit is not reflected here", "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" "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" "partnerid", "kind" "optional", "type" "string", "description" "your partner id in the cross river system", "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" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified ", "children" \[] }, { "name" "productname", "kind" "optional", "type" "string", "description" "name of your product at cross river", "children" \[] }, { "name" "partnername", "kind" "optional", "type" "string", "description" "your partner name in the cross river system", "children" \[] } ] }