Restrict account

payments that fail to post and are returned will not be visible to you { "name" "endpoint /core/v1/dda/accounts/{accountnumber}/restrictions", "method" "post", "url" "https //sandbox crbcos com/core/v1/dda/accounts/{accountnumber}/restrictions", "description" "restricts an account from defined transactions \na restriction is a flexible way to prevent transactions that contain certain criteria from posting to an account this is useful in scenarios such as freezing an account that has been compromised ", "tab" "examples", "examples" { "languages" \[ { "id" "eajf8kulybaue23vi6 pj", "language" "curl", "code" "curl location globoff 'https //sandbox crbcos com/core/v1/dda/accounts/2394312736/restrictions' \\\\\n data '{\n \\"transactioncode\\" \\"incoming ach\\",\n \\"transactiontype\\" \\"debit\\",\n \\"appliesto\\" \\"account\\",\n \\"reason\\" \\"account freeze\\"\n}'", "customlabel" "" }, { "id" "cy8a59lipkdu7tz5onrn5", "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/{accountnumber}/restrictions?accountnumber=2394312736',\n 'headers' {\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 = \\"{\\\r\\\n \\\\\\"transactioncode\\\\\\" \\\\\\"incoming ach\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"debit\\\\\\",\\\r\\\n \\\\\\"appliesto\\\\\\" \\\\\\"account\\\\\\",\\\r\\\n \\\\\\"reason\\\\\\" \\\\\\"account freeze\\\\\\"\\\r\\\n}\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "gzfc4rhgevrbkzsqlfwdv", "language" "python", "code" "import http client\n\nconn = http client httpsconnection(\\"sandbox crbcos com\\")\npayload = \\"{\\\r\\\n \\\\\\"transactioncode\\\\\\" \\\\\\"incoming ach\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"debit\\\\\\",\\\r\\\n \\\\\\"appliesto\\\\\\" \\\\\\"account\\\\\\",\\\r\\\n \\\\\\"reason\\\\\\" \\\\\\"account freeze\\\\\\"\\\r\\\n}\\"\nheaders = {}\nconn request(\\"post\\", \\"/core/v1/dda/accounts/{accountnumber}/restrictions?accountnumber=2394312736\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "customlabel" "" }, { "id" "fzavycld2vsa0ushprkfl", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/core/v1/dda/accounts/{accountnumber}/restrictions?accountnumber=2394312736\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest body = \\"{\\\r\\\n \\\\\\"transactioncode\\\\\\" \\\\\\"incoming ach\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"debit\\\\\\",\\\r\\\n \\\\\\"appliesto\\\\\\" \\\\\\"account\\\\\\",\\\r\\\n \\\\\\"reason\\\\\\" \\\\\\"account freeze\\\\\\"\\\r\\\n}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "jtfd5c4ocb vxdqotk0k", "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/{accountnumber}/restrictions?accountnumber=2394312736\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"transactioncode\\" \\"incoming ach\\",`+\\"\n\\"+`\n \\"transactiontype\\" \\"debit\\",`+\\"\n\\"+`\n \\"appliesto\\" \\"account\\",`+\\"\n\\"+`\n \\"reason\\" \\"account freeze\\"`+\\"\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 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" "eajf8kulybaue23vi6 pj" }, "results" { "languages" \[ { "id" "92j7q9aihp7t6q1bc5jtc", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"51d73b46 ef2a 4a52 b174 b32f00949088\\",\n \\"masteraccountnumber\\" \\"2394312736\\",\n \\"subaccountnumber\\" \\"2394312736\\",\n \\"restrictiontype\\" \\"internal\\",\n \\"appliesto\\" \\"account\\",\n \\"status\\" \\"active\\",\n \\"transactiontype\\" \\"debit\\",\n \\"transactioncode\\" \\"incoming ach\\",\n \\"reason\\" \\"account freeze\\",\n \\"createdat\\" \\"2025 08 04t05 00 54 4238173 04 00\\",\n \\"partnerid\\" \\"cd9c12f4 7691 424a b38b af5b0134c611\\",\n \\"lastmodifiedat\\" \\"2025 08 04t05 00 54 4238173 04 00\\"\n}" } ], "selectedlanguageid" "92j7q9aihp7t6q1bc5jtc" }, "request" { "pathparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "number of the customer's account to be restricted", "" "number of the customer's account to be restricted" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "subaccountnumber", "kind" "optional", "type" "string", "description" "if restricting a specific subaccount, that account number", "" "if restricting a specific subaccount, that account number" }, { "name" "appliesto", "kind" "required", "type" "string", "description" "depending on the restriction you apply \n all\n account\n subaccounts\nwe recommened using 'account'", "" "depending on the restriction you apply \n all\n account\n subaccounts\nwe recommened using 'account'" }, { "name" "rail", "kind" "optional", "type" "string", "description" "indicates if the restriction should apply to a specific rail the most commonly used values are 'ach', 'wires', and 'rtp' \n ach\n wires\n creditcard\n debitcard\n storedvalue\n checks\n xpay\n rtp\n crypto\n cardmanagement\n international\n cardpayments\n internal", "" "indicates if the restriction should apply to a specific rail the most commonly used values are 'ach', 'wires', and 'rtp' \n ach\n wires\n creditcard\n debitcard\n storedvalue\n checks\n xpay\n rtp\n crypto\n cardmanagement\n international\n cardpayments\n internal" }, { "name" "transactiontype", "kind" "optional", "type" "string", "description" "type of transaction to be restricted \n debit\n credit", "" "type of transaction to be restricted \n debit\n credit" }, { "name" "otheraccounttype", "kind" "optional", "type" "string", "description" "do not use ", "" "do not use " }, { "name" "amountthreshold", "kind" "optional", "type" "integer", "description" "specifies an amount threshold the restriction applys to any transaction amount that is equal to or greater than the amount entered \nthis value is in integral cents, meaning write the number including cents, with no decimal point for example, 100 usd appears as 10000 ", "" "specifies an amount threshold the restriction applys to any transaction amount that is equal to or greater than the amount entered \nthis value is in integral cents, meaning write the number including cents, with no decimal point for example, 100 usd appears as 10000 " }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency used in the transaction", "" "currency used in the transaction" }, { "name" "transactioncode", "kind" "optional", "type" "string", "description" "indicates a specific transaction code, such as ‘incoming ach’", "" "indicates a specific transaction code, such as ‘incoming ach’" }, { "name" "effectivestarttimehour", "kind" "optional", "type" "integer", "description" "indicates the approximate start hour of the restriction use a 24 hour clock ", "" "indicates the approximate start hour of the restriction use a 24 hour clock " }, { "name" "effectivestarttimeminute", "kind" "optional", "type" "integer", "description" "indicates the approximate start minute of the restriction", "" "indicates the approximate start minute of the restriction" }, { "name" "effectiveendtimehour", "kind" "optional", "type" "integer", "description" "indicates the approximate end hour of the restriction use a 24 hour clock ", "" "indicates the approximate end hour of the restriction use a 24 hour clock " }, { "name" "effectiveendtimeminute", "kind" "optional", "type" "integer", "description" "indicates the approximate end minute of the restriction", "" "indicates the approximate end minute of the restriction" }, { "name" "reason", "kind" "required", "type" "string", "description" "justification for applying the restriction", "" "justification for applying the restriction" }, { "name" "notes", "kind" "optional", "type" "string", "description" "any other information about the restriction generally not used ", "" "any other information about the restriction generally not used " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the guid id identifying this restriction" }, { "name" "masteraccountnumber", "kind" "optional", "type" "string", "description" "number of the customer's account to be restricted", "children" \[] }, { "name" "subaccountnumber", "kind" "optional", "type" "string", "description" "if restricting a specific subaccount, that account number", "children" \[] }, { "name" "restrictiontype", "kind" "optional", "type" "string", "description" "who applied the restriction \n partner\n internal", "children" \[] }, { "name" "appliesto", "kind" "optional", "type" "string", "description" "restriction coverage \n all\n account\n subaccounts", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "status of the restriction \n inactive\n active", "children" \[] }, { "name" "rail", "kind" "optional", "type" "string", "description" "type of restriction applied \n ach\n wires\n creditcard\n debitcard\n storedvalue\n checks\n xpay\n rtp\n crypto\n cardmanagement\n international\n cardpayments\n internal", "children" \[] }, { "name" "transactiontype", "kind" "optional", "type" "string", "description" "type of transaction restricted \n debit\n credit", "children" \[] }, { "name" "otheraccounttype", "kind" "optional", "type" "string", "description" "not used", "children" \[] }, { "name" "transactioncode", "kind" "optional", "type" "string", "description" "indicates a specific transaction code, such as ‘incoming ach’", "children" \[] }, { "name" "amountthreshold", "kind" "optional", "type" "integer", "description" "specifies an amount threshold the restriction applys to any transaction amount that is equal to or greater than the amount entered \nthis value is in integral cents, meaning the number includes cents, with no decimal point for example, 100 usd appears as 10000 ", "children" \[] }, { "name" "effectivestarttimehour", "kind" "optional", "type" "integer", "description" "indicates the approximate start hour of the restriction use a 24 hour clock ", "children" \[] }, { "name" "effectivestarttimeminute", "kind" "optional", "type" "integer", "description" "indicates the approximate start minute of the restriction", "children" \[] }, { "name" "effectiveendtimehour", "kind" "optional", "type" "integer", "description" "indicates the approximate end hour of the restriction use a 24 hour clock ", "children" \[] }, { "name" "effectiveendtimeminute", "kind" "optional", "type" "integer", "description" "indicates the approximate end minute of the restriction", "children" \[] }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency held in the account", "children" \[] }, { "name" "reason", "kind" "optional", "type" "string", "description" "justification for applying the restriction", "children" \[] }, { "name" "notes", "kind" "optional", "type" "string", "description" "any other information about the restriction generally not used ", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "restriction created in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "removedat", "kind" "optional", "type" "string", "description" "restriction removed in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "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" \[] } ] }