Send batch

relevant webhooks for this endpoint be sure you have docid\ bn5xtgkjogbe ctwomcbs for this webhook ach batch imported api reference submits 2 or more transactions as a batch note that each batch payment must be originated from the same cross river account number if originating from multiple cross river accounts, the transactions from each account must be submitted as separate batches for each transaction, include the request attributes in the payments object of the request as shown in the code snippet { "name" "endpoint /ach/v1/client batches", "method" "post", "url" "https //sandbox crbcos com/ach/v1/client batches", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" " hxtkonxwzfyqhuht xyl", "language" "curl", "code" "curl location 'https //sandbox crbcos com/ach/v1/client batches' \\\\\n header 'idempotency key 9edef3ad 8084 45d2 ab71 c0d706cd221a' \\\\\n data '{\n \\"payments\\" \[\n {\n \\"accountnumber\\" \\"2151546989\\",\n \\"receiver\\" {\n \\"routingnumber\\" \\"021000021\\",\n \\"accountnumber\\" \\"12345678\\",\n \\"accounttype\\" \\"checking\\",\n \\"name\\" \\"peter griffin\\"\n },\n \\"seccode\\" \\"ppd\\",\n \\"description\\" \\"string\\",\n \\"transactiontype\\" \\"push\\",\n \\"amount\\" 115,\n \\"servicetype\\" \\"standard\\"\n },\n{\n \\"accountnumber\\" \\"2151546989\\",\n \\"receiver\\" {\n \\"routingnumber\\" \\"021000021\\",\n \\"accountnumber\\" \\"65325148\\",\n \\"accounttype\\" \\"checking\\",\n \\"name\\" \\"tommy jones\\"\n },\n \\"seccode\\" \\"ppd\\",\n \\"description\\" \\"string\\",\n \\"transactiontype\\" \\"push\\",\n \\"amount\\" 117,\n \\"servicetype\\" \\"sameday\\"\n },\n{\n \\"accountnumber\\" \\"2151546989\\",\n \\"receiver\\" {\n \\"routingnumber\\" \\"021000021\\",\n \\"accountnumber\\" \\"65325148\\",\n \\"accounttype\\" \\"checking\\",\n \\"name\\" \\"john wick\\"\n },\n \\"seccode\\" \\"ppd\\",\n \\"description\\" \\"string\\",\n \\"transactiontype\\" \\"push\\",\n \\"amount\\" 119,\n \\"servicetype\\" \\"sameday\\"\n }\n ]\n}\n\n'", "customlabel" "" }, { "id" "zy8wzwlqagfjpeg p79 v", "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' '/ach/v1/client batches',\n 'headers' {\n 'idempotency key' '9edef3ad 8084 45d2 ab71 c0d706cd221a'\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 \\\\\\"payments\\\\\\" \[\\\r\\\n {\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"12345678\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"peter griffin\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 115,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"standard\\\\\\"\\\r\\\n },\\\r\\\n{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"65325148\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"tommy jones\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 117,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\"\\\r\\\n },\\\r\\\n{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"65325148\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"john wick\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 119,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\"\\\r\\\n }\\\r\\\n ]\\\r\\\n}\\\r\\\n\\\r\\\n\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "hqe2lvltkn9bui8q type", "language" "python", "code" "import http client\n\nconn = http client httpsconnection(\\"sandbox crbcos com\\")\npayload = \\"{\\\r\\\n \\\\\\"payments\\\\\\" \[\\\r\\\n {\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"12345678\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"peter griffin\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 115,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"standard\\\\\\"\\\r\\\n },\\\r\\\n{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"65325148\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"tommy jones\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 117,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\"\\\r\\\n },\\\r\\\n{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"65325148\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"john wick\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 119,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\"\\\r\\\n }\\\r\\\n ]\\\r\\\n}\\\r\\\n\\\r\\\n\\"\nheaders = {\n 'idempotency key' '9edef3ad 8084 45d2 ab71 c0d706cd221a'\n}\nconn request(\\"post\\", \\"/ach/v1/client batches\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "customlabel" "" }, { "id" "zqaczjwgazd 5vedbbylb", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/ach/v1/client batches\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"idempotency key\\"] = \\"9edef3ad 8084 45d2 ab71 c0d706cd221a\\"\nrequest body = \\"{\\\r\\\n \\\\\\"payments\\\\\\" \[\\\r\\\n {\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"12345678\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"peter griffin\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 115,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"standard\\\\\\"\\\r\\\n },\\\r\\\n{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"65325148\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"tommy jones\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 117,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\"\\\r\\\n },\\\r\\\n{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2151546989\\\\\\",\\\r\\\n \\\\\\"receiver\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"65325148\\\\\\",\\\r\\\n \\\\\\"accounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"john wick\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"string\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 119,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\"\\\r\\\n }\\\r\\\n ]\\\r\\\n}\\\r\\\n\\\r\\\n\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "ul2uk7a5o3h3eqjrjue45", "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/ach/v1/client batches\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"payments\\" \[`+\\"\n\\"+`\n {`+\\"\n\\"+`\n \\"accountnumber\\" \\"2151546989\\",`+\\"\n\\"+`\n \\"receiver\\" {`+\\"\n\\"+`\n \\"routingnumber\\" \\"021000021\\",`+\\"\n\\"+`\n \\"accountnumber\\" \\"12345678\\",`+\\"\n\\"+`\n \\"accounttype\\" \\"checking\\",`+\\"\n\\"+`\n \\"name\\" \\"peter griffin\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n \\"seccode\\" \\"ppd\\",`+\\"\n\\"+`\n \\"description\\" \\"string\\",`+\\"\n\\"+`\n \\"transactiontype\\" \\"push\\",`+\\"\n\\"+`\n \\"amount\\" 115,`+\\"\n\\"+`\n \\"servicetype\\" \\"standard\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n{`+\\"\n\\"+`\n \\"accountnumber\\" \\"2151546989\\",`+\\"\n\\"+`\n \\"receiver\\" {`+\\"\n\\"+`\n \\"routingnumber\\" \\"021000021\\",`+\\"\n\\"+`\n \\"accountnumber\\" \\"65325148\\",`+\\"\n\\"+`\n \\"accounttype\\" \\"checking\\",`+\\"\n\\"+`\n \\"name\\" \\"tommy jones\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n \\"seccode\\" \\"ppd\\",`+\\"\n\\"+`\n \\"description\\" \\"string\\",`+\\"\n\\"+`\n \\"transactiontype\\" \\"push\\",`+\\"\n\\"+`\n \\"amount\\" 117,`+\\"\n\\"+`\n \\"servicetype\\" \\"sameday\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n{`+\\"\n\\"+`\n \\"accountnumber\\" \\"2151546989\\",`+\\"\n\\"+`\n \\"receiver\\" {`+\\"\n\\"+`\n \\"routingnumber\\" \\"021000021\\",`+\\"\n\\"+`\n \\"accountnumber\\" \\"65325148\\",`+\\"\n\\"+`\n \\"accounttype\\" \\"checking\\",`+\\"\n\\"+`\n \\"name\\" \\"john wick\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n \\"seccode\\" \\"ppd\\",`+\\"\n\\"+`\n \\"description\\" \\"string\\",`+\\"\n\\"+`\n \\"transactiontype\\" \\"push\\",`+\\"\n\\"+`\n \\"amount\\" 119,`+\\"\n\\"+`\n \\"servicetype\\" \\"sameday\\"`+\\"\n\\"+`\n }`+\\"\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\\", \\"9edef3ad 8084 45d2 ab71 c0d706cd221a\\")\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" " hxtkonxwzfyqhuht xyl" }, "results" { "languages" \[ { "id" "kujiqc9dmrfzqaq91s0q2", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"c51248db 9e07 4439 ace4 b1d800fd803a\\",\n \\"referenceid\\" \\"cb239to0yk9if\\",\n \\"status\\" \\"processing\\",\n \\"accountnumber\\" \\"2207975570\\",\n \\"paymentcount\\" 2,\n \\"debittotal\\" 0,\n \\"credittotal\\" 87500,\n \\"importcount\\" 0,\n \\"clientidentifier\\" \\"3cbc5d4b 7fe5 4c3c 9187 c5c0cd94d811\\",\n \\"productid\\" \\"cc62e17f 5912 483e 9e42 aed30112fbb6\\",\n \\"partnerid\\" \\"1e5d3f04 ae24 4af6 9e30 aecf012b99dd\\",\n \\"createdat\\" \\"2024 08 26t11 22 58 1078604 04 00\\",\n \\"lastmodifiedat\\" \\"2024 08 26t11 22 58 1078604 04 00\\",\n \\"paymentidentifiers\\" \[\n \\"993a2f38 3e51 4637 a566 b1d800fd803a\\",\n \\"a09f25b3 0f23 4b6e bb11 b1d800fd803a\\"\n ]\n}" } ], "selectedlanguageid" "kujiqc9dmrfzqaq91s0q2" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "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 \n\nuse this field to enter a clientidentifier for the entire batch you can also add a separate clientidentifier for each payment ", "" "optional" }, { "name" "payments", "kind" "optional", "type" "object", "description" "the information for each payment in the batch ", "children" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "account number for payment originator" }, { "name" "originator", "kind" "optional", "type" "object", "description" "details about the entity sending the payment if the account originating the payment is enabled to provide this information according to the supplied account number, all the values should be null if these values are supplied in the request they override the originator profile defined for the account ", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of the originator of the transaction nacha refers to this as company name 35 character maximum unless the seccode is iat in that case the maximum is only 16 characters " }, { "name" "identification", "kind" "required", "type" "string", "description" "originator identification nacha refers to this as the company identification 10 character maximum " }, { "name" "data", "kind" "optional", "type" "string", "description" "originator data nacha refers to this as company discretionary data 20 character maximum " } ] }, { "name" "receiver", "kind" "required", "type" "object", "description" "in the case of pull payments, this is the account the funds are being pulled from ", "children" \[ { "name" " routingnumber", "kind" "required", "type" "string", "description" "federal routing number for the receiver bank" }, { "name" "accountnumber", "kind" "required", "type" "string", "description" "account number for the receiver must be 7 digits for account numbers with 5 or 6 digits, add 0s to the beginning of the account number " }, { "name" "accounttype", "kind" "required", "type" "string", "description" "deposit account type checking, savings, generalledger, loan" }, { "name" "name", "kind" "optional", "type" "string", "description" "receiver name maximum 22 characters " }, { "name" "identification", "kind" "optional", "type" "string", "description" "receiver identification nacha refers to this as the individual identification number 15 character maximum " } ] }, { "name" "seccode", "kind" "required", "type" "string", "description" "standard entry class (sec) codes required by nacha for every ach transaction " }, { "name" "description", "kind" "required", "type" "string", "description" "description of the payment maximum 10 characters " }, { "name" "transactiontype", "kind" "required", "type" "string", "description" "sending or requesting funds \n push (originator is sending funds—debit)\n pull (originator is receiving funds—credit)" }, { "name" "amount", "kind" "required", "type" "integer", "description" "dollar amount of payment in positive integral cents for example, $1 00 appears as 100 " }, { "name" " servicetype", "kind" "required", "type" "string", "description" "when the payment completes \n\n standard (payment effective the following business day international payments must use this service type )\n sameday (payment effective same day, subject to certain constraints see ach overview )" }, { "name" "fedbatchwindow", "kind" "optional", "type" "integer", "description" "" } ], "schema" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "account number for payment originator" }, { "name" "originator", "kind" "optional", "type" "object", "description" "details about the entity sending the payment if the account originating the payment is enabled to provide this information according to the supplied account number, all the values should be null if these values are supplied in the request they override the originator profile defined for the account ", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of the originator of the transaction nacha refers to this as company name 35 character maximum unless the seccode is iat in that case the maximum is only 16 characters " }, { "name" "identification", "kind" "required", "type" "string", "description" "originator identification nacha refers to this as the company identification 10 character maximum " }, { "name" "data", "kind" "optional", "type" "string", "description" "originator data nacha refers to this as company discretionary data 20 character maximum " } ] }, { "name" "receiver", "kind" "required", "type" "object", "description" "in the case of pull payments, this is the account the funds are being pulled from ", "children" \[ { "name" " routingnumber", "kind" "required", "type" "string", "description" "federal routing number for the receiver bank" }, { "name" "accountnumber", "kind" "required", "type" "string", "description" "account number for the receiver must be 7 digits for account numbers with 5 or 6 digits, add 0s to the beginning of the account number " }, { "name" "accounttype", "kind" "required", "type" "string", "description" "deposit account type checking, savings, generalledger, loan" }, { "name" "name", "kind" "optional", "type" "string", "description" "receiver name maximum 22 characters " }, { "name" "identification", "kind" "optional", "type" "string", "description" "receiver identification nacha refers to this as the individual identification number 15 character maximum " } ] }, { "name" "seccode", "kind" "required", "type" "string", "description" "standard entry class (sec) codes required by nacha for every ach transaction " }, { "name" "description", "kind" "required", "type" "string", "description" "description of the payment maximum 10 characters " }, { "name" "transactiontype", "kind" "required", "type" "string", "description" "sending or requesting funds \n push (originator is sending funds—debit)\n pull (originator is receiving funds—credit)" }, { "name" "amount", "kind" "required", "type" "integer", "description" "dollar amount of payment in positive integral cents for example, $1 00 appears as 100 " }, { "name" " servicetype", "kind" "required", "type" "string", "description" "when the payment completes \n\n standard (payment effective the following business day international payments must use this service type )\n sameday (payment effective same day, subject to certain constraints see ach overview )" }, { "name" "fedbatchwindow", "kind" "optional", "type" "integer", "description" "" } ] }, { "name" "extendeddetails", "kind" "optional", "type" "object", "description" "ach specific details \n\nif the transactiontype is pull and seccode is web you must include a paymenttype value in this object \n\nif the seccode is pos you must include a cardtransactiontype value \n\nlearn more on the nacha site ", "children" \[ { "name" "authcode", "kind" "optional", "type" "string", "description" "authorization code related to card based transactions" }, { "name" "cardaccountnumber", "kind" "optional", "type" "string", "description" "card account number used in the transaction" }, { "name" "cardexpdate", "kind" "optional", "type" "string", "description" "expiration date of the card used" }, { "name" "cardtransactiontype", "kind" "optional", "type" "string", "description" "card transaction types are represented by specific codes that explain what kind of transaction took place at the point of sale" }, { "name" "checkserialnumber", "kind" "optional", "type" "string", "description" "serial number for check based transactions" }, { "name" "docreferencenumber", "kind" "optional", "type" "string", "description" "document reference number associated with the transaction" }, { "name" "itemtype", "kind" "optional", "type" "string", "description" "type of financial item, for example, check or card" }, { "name" "networkidentification", "kind" "optional", "type" "string", "description" "network through which the transaction was processed" }, { "name" "paymenttype", "kind" "optional", "type" "string", "description" "payment types are a single character, and are based on the authorization of the account holder to debit their account \n s for single\n r for recurring" }, { "name" "processcontrol", "kind" "optional", "type" "string", "description" "internal cross river processing control code" }, { "name" "reference1", "kind" "optional", "type" "string", "description" "reference field for reconciliation" }, { "name" "reference2", "kind" "optional", "type" "string", "description" "reference field for reconciliation" }, { "name" "researchnumber", "kind" "optional", "type" "string", "description" "research id for dispute or trace purposes" }, { "name" "terminalidentification", "kind" "optional", "type" "string", "description" "id of the terminal where the transaction occurred" }, { "name" "terminallocation", "kind" "optional", "type" "string", "description" "location descriptor of the terminal" }, { "name" "terminalcity", "kind" "optional", "type" "string", "description" "city where the terminal is located" }, { "name" "terminalstate", "kind" "optional", "type" "string", "description" "state where the terminal is locationed" }, { "name" "transactiondate", "kind" "optional", "type" "string", "description" "date the transaction happened" }, { "name" "transactiondesc", "kind" "optional", "type" "string", "description" "additional description of the transaction" }, { "name" "transactionserial", "kind" "optional", "type" "string", "description" "additional description of the transaction" }, { "name" "transactiontime", "kind" "optional", "type" "string", "description" "transaction timestamp" } ], "schema" \[ { "name" "authcode", "kind" "optional", "type" "string", "description" "authorization code related to card based transactions" }, { "name" "cardaccountnumber", "kind" "optional", "type" "string", "description" "card account number used in the transaction" }, { "name" "cardexpdate", "kind" "optional", "type" "string", "description" "expiration date of the card used" }, { "name" "cardtransactiontype", "kind" "optional", "type" "string", "description" "card transaction types are represented by specific codes that explain what kind of transaction took place at the point of sale" }, { "name" "checkserialnumber", "kind" "optional", "type" "string", "description" "serial number for check based transactions" }, { "name" "docreferencenumber", "kind" "optional", "type" "string", "description" "document reference number associated with the transaction" }, { "name" "itemtype", "kind" "optional", "type" "string", "description" "type of financial item, for example, check or card" }, { "name" "networkidentification", "kind" "optional", "type" "string", "description" "network through which the transaction was processed" }, { "name" "paymenttype", "kind" "optional", "type" "string", "description" "payment types are a single character, and are based on the authorization of the account holder to debit their account \n s for single\n r for recurring" }, { "name" "processcontrol", "kind" "optional", "type" "string", "description" "internal cross river processing control code" }, { "name" "reference1", "kind" "optional", "type" "string", "description" "reference field for reconciliation" }, { "name" "reference2", "kind" "optional", "type" "string", "description" "reference field for reconciliation" }, { "name" "researchnumber", "kind" "optional", "type" "string", "description" "research id for dispute or trace purposes" }, { "name" "terminalidentification", "kind" "optional", "type" "string", "description" "id of the terminal where the transaction occurred" }, { "name" "terminallocation", "kind" "optional", "type" "string", "description" "location descriptor of the terminal" }, { "name" "terminalcity", "kind" "optional", "type" "string", "description" "city where the terminal is located" }, { "name" "terminalstate", "kind" "optional", "type" "string", "description" "state where the terminal is locationed" }, { "name" "transactiondate", "kind" "optional", "type" "string", "description" "date the transaction happened" }, { "name" "transactiondesc", "kind" "optional", "type" "string", "description" "additional description of the transaction" }, { "name" "transactionserial", "kind" "optional", "type" "string", "description" "additional description of the transaction" }, { "name" "transactiontime", "kind" "optional", "type" "string", "description" "transaction timestamp" } ] }, { "name" "iatdetails", "kind" "optional", "type" "object", "description" "required if the seccode is iat \n\ndo not enter values for these attributes for any other seccode ", "children" \[ { "name" "originator", "kind" "optional", "type" "object", "description" "payment sender details", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "city full name 33 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name 33 characters maximum " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code regular expression 32 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receiver", "kind" "required", "type" "object", "description" "payment receiver details", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "city full name 33 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name 33 characters maximum " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code regular expression 32 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "originatingbank", "kind" "optional", "type" "object", "description" "details of financial institution originating the iat", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "originating dfi identification number qualifier \n 01 (national clearing system number for example, us routing transit number)\n 02 bic code\n 03 iban" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receivingbank", "kind" "required", "type" "object", "description" "details of financial institution receiving the iat", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "originating dfi identification number qualifier \n 01 (national clearing system number for example, us routing transit number)\n 02 bic code\n 03 iban" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "correspondentbank1", "kind" "optional", "type" "object", "description" "details of a correspondent (intermediary) bank, if there is one \n\nyou can have up to 5 correspondent banks (correspondentbank1, correspondentbank2, correspondentbank3, correspondentbank4, correspondentbank5 , each with the same child attributes ", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "originating dfi identification number qualifier \n 01 (national clearing system number for example, us routing transit number)\n 02 bic code\n 03 iban" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "transactiontypecode", "kind" "required", "type" "string", "description" "part of the addenda record an additional way to explain the purpose of the iat see the ach request and response codes page for iat transaction types " }, { "name" "originatingcurrency", "kind" "optional", "type" "string", "description" "an iso three character code to identify the originating currency" }, { "name" "destinationcurrency", "kind" "optional", "type" "string", "description" "an iso three character code to identify the receiving currency" }, { "name" "remittanceinfo1", "kind" "optional", "type" "string", "description" "additional iat information 80 characters a second field is available as remittanceinfo2 " } ], "schema" \[ { "name" "originator", "kind" "optional", "type" "object", "description" "payment sender details", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "city full name 33 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name 33 characters maximum " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code regular expression 32 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receiver", "kind" "required", "type" "object", "description" "payment receiver details", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "city full name 33 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "state name 33 characters maximum " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal code regular expression 32 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "originatingbank", "kind" "optional", "type" "object", "description" "details of financial institution originating the iat", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "originating dfi identification number qualifier \n 01 (national clearing system number for example, us routing transit number)\n 02 bic code\n 03 iban" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receivingbank", "kind" "required", "type" "object", "description" "details of financial institution receiving the iat", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "originating dfi identification number qualifier \n 01 (national clearing system number for example, us routing transit number)\n 02 bic code\n 03 iban" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "correspondentbank1", "kind" "optional", "type" "object", "description" "details of a correspondent (intermediary) bank, if there is one \n\nyou can have up to 5 correspondent banks (correspondentbank1, correspondentbank2, correspondentbank3, correspondentbank4, correspondentbank5 , each with the same child attributes ", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "originating dfi identification number qualifier \n 01 (national clearing system number for example, us routing transit number)\n 02 bic code\n 03 iban" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "transactiontypecode", "kind" "required", "type" "string", "description" "part of the addenda record an additional way to explain the purpose of the iat see the ach request and response codes page for iat transaction types " }, { "name" "originatingcurrency", "kind" "optional", "type" "string", "description" "an iso three character code to identify the originating currency" }, { "name" "destinationcurrency", "kind" "optional", "type" "string", "description" "an iso three character code to identify the receiving currency" }, { "name" "remittanceinfo1", "kind" "optional", "type" "string", "description" "additional iat information 80 characters a second field is available as remittanceinfo2 " } ] }, { "name" "addenda", "kind" "optional", "type" "string", "description" "supplemental data to identify an account holder or provide information about the payment this may include details such as invoice numbers ", "" "supplemental data to identify an account holder or provide information about the payment this may include details such as invoice numbers " }, { "name" "purpose", "kind" "optional", "type" "string", "description" "reason for the ach transfer for internal use only the data is not included with the outgoing ach batch file ", "" "reason for the ach transfer for internal use only the data is not included with the outgoing ach batch file " }, { "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 ", "" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes " }, { "name" "externalprefix", "kind" "optional", "type" "string", "description" "prefix from external system integration", "" "prefix from external system integration" }, { "name" "externalaccountnumber", "kind" "optional", "type" "string", "description" "external facing account reference number", "" "external facing account reference number" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "unique id for the client batch request this id is in the guid format " }, { "name" "referenceid", "kind" "optional", "type" "string", "description" "unique cr reference id for the payment the reference id always begins with the first letter of the rail for ach the reference id starts with 'a' ", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "status of the transaction \n processing\n imported\n canceling", "children" \[] }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "the cross river account number from which the batch payments originate depending on the account type, the number of digits will vary the first digit indicates the kind of account ", "children" \[] }, { "name" "paymentcount", "kind" "optional", "type" "integer", "description" "the number of unique payments in the batch (up to 5000)", "children" \[] }, { "name" "debittotal", "kind" "optional", "type" "integer", "description" "the total amount to be credited to the originator account", "children" \[] }, { "name" "credittotal", "kind" "optional", "type" "integer", "description" "the total amount to be debited from the originator account", "children" \[] }, { "name" "importcount", "kind" "optional", "type" "string", "description" "indicates how many payments have been processed at the time of the response", "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 in this case, the cr account involved in the batch payment see also here ", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your id in the cr system this id is in guid format ", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "when the client batch was created after the request was received", "children" \[] }, { "name" "importedat", "kind" "optional", "type" "string", "description" "the time when the import count matches the total number of payments in the batch", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cr value date and time the database entry was last modified \n\n", "children" \[] }, { "name" "paymentidentifiers", "kind" "optional", "type" "array", "description" "unique identifier for each payment in the batch, in guid format ", "children" \[] } ], "autogeneratedanchorslug" "endpoint achv1client batches", "legacyhash" "z2rk6gf hjgrsp5qjex3l" }