Simulate inbound ACH origination

api reference simulate receiving an ach credit transfer payment from another financial institution the response body duplicates the request body this api can only be run in the cross river sandbox docid kaqyvqvnuagqnekfkcuy { "name" "endpoint /v1/payments/simulated inbound originations", "method" "post", "url" "https //sandbox crbcos com/ach/v1/payments/simulated inbound originations", "tab" "examples", "examples" { "languages" \[ { "id" "curl example", "language" "curl", "code" "curl location 'https //sandbox crbcos com/ach/v1/payments/simulated inbound originations' \\\\\n data '{\n \\"originatorroutingnumber\\" \\"021000021\\",\n \\"originatorname\\" \\"tom smith\\",\n \\"originatoridentification\\" \\"99999999\\",\n \\"receiveraccountnumber\\" \\"2819503463\\",\n \\"receiveraccounttype\\" \\"checking\\",\n \\"receivername\\" \\"jerry penn\\",\n \\"receiveridentification\\" \\"inv123\\",\n \\"seccode\\" \\"ppd\\",\n \\"description\\" \\"testing\\",\n \\"transactiontype\\" \\"push\\",\n \\"amount\\" 1000,\n \\"servicetype\\" \\"sameday\\", \n}'" }, { "id" "nodejs example", "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/payments/simulated inbound originations',\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 \\\\\\"originatorroutingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"originatorname\\\\\\" \\\\\\"tom smith\\\\\\",\\\r\\\n \\\\\\"originatoridentification\\\\\\" \\\\\\"99999999\\\\\\",\\\r\\\n \\\\\\"receiveraccountnumber\\\\\\" \\\\\\"2819503463\\\\\\",\\\r\\\n \\\\\\"receiveraccounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"receivername\\\\\\" \\\\\\"jerry penn\\\\\\",\\\r\\\n \\\\\\"receiveridentification\\\\\\" \\\\\\"inv123\\\\\\",\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"testing\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 1000,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\", \\\r\\\n}\\";\n\nreq write(postdata);\n\nreq end();" }, { "id" "python example", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/ach/v1/payments/simulated inbound originations\\"\n\npayload = \\"{\\\r\\\n \\\\\\"originatorroutingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"originatorname\\\\\\" \\\\\\"tom smith\\\\\\",\\\r\\\n \\\\\\"originatoridentification\\\\\\" \\\\\\"99999999\\\\\\",\\\r\\\n \\\\\\"receiveraccountnumber\\\\\\" \\\\\\"2819503463\\\\\\",\\\r\\\n \\\\\\"receiveraccounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"receivername\\\\\\" \\\\\\"jerry penn\\\\\\",\\\r\\\n \\\\\\"receiveridentification\\\\\\" \\\\\\"inv123\\\\\\",\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"testing\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 1000,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\", \\\r\\\n}\\"\nheaders = {}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n" }, { "id" "ruby example", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/ach/v1/payments/simulated inbound originations\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest body = \\"{\\\r\\\n \\\\\\"originatorroutingnumber\\\\\\" \\\\\\"021000021\\\\\\",\\\r\\\n \\\\\\"originatorname\\\\\\" \\\\\\"tom smith\\\\\\",\\\r\\\n \\\\\\"originatoridentification\\\\\\" \\\\\\"99999999\\\\\\",\\\r\\\n \\\\\\"receiveraccountnumber\\\\\\" \\\\\\"2819503463\\\\\\",\\\r\\\n \\\\\\"receiveraccounttype\\\\\\" \\\\\\"checking\\\\\\",\\\r\\\n \\\\\\"receivername\\\\\\" \\\\\\"jerry penn\\\\\\",\\\r\\\n \\\\\\"receiveridentification\\\\\\" \\\\\\"inv123\\\\\\",\\\r\\\n \\\\\\"seccode\\\\\\" \\\\\\"ppd\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"testing\\\\\\",\\\r\\\n \\\\\\"transactiontype\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 1000,\\\r\\\n \\\\\\"servicetype\\\\\\" \\\\\\"sameday\\\\\\", \\\r\\\n}\\"\n\nresponse = https request(request)\nputs response read body\n" }, { "id" "go example", "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/payments/simulated inbound originations\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"originatorroutingnumber\\" \\"021000021\\",`+\\"\n\\"+`\n \\"originatorname\\" \\"tom smith\\",`+\\"\n\\"+`\n \\"originatoridentification\\" \\"99999999\\",`+\\"\n\\"+`\n \\"receiveraccountnumber\\" \\"2819503463\\",`+\\"\n\\"+`\n \\"receiveraccounttype\\" \\"checking\\",`+\\"\n\\"+`\n \\"receivername\\" \\"jerry penn\\",`+\\"\n\\"+`\n \\"receiveridentification\\" \\"inv123\\",`+\\"\n\\"+`\n \\"seccode\\" \\"ppd\\",`+\\"\n\\"+`\n \\"description\\" \\"testing\\",`+\\"\n\\"+`\n \\"transactiontype\\" \\"push\\",`+\\"\n\\"+`\n \\"amount\\" 1000,`+\\"\n\\"+`\n \\"servicetype\\" \\"sameday\\", `+\\"\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}" } ], "selectedlanguageid" "curl example" }, "results" { "languages" \[ { "id" "200", "language" "200", "code" "{\n \\"originatorroutingnumber\\" \\"021000021\\",\n \\"originatorname\\" \\"tom smith\\",\n \\"originatoridentification\\" \\"99999999\\",\n \\"receiveraccountnumber\\" \\"2819503463\\",\n \\"receiveraccounttype\\" \\"checking\\",\n \\"receivername\\" \\"jerry penn\\",\n \\"receiveridentification\\" \\"inv123\\",\n \\"seccode\\" \\"ppd\\",\n \\"description\\" \\"testing\\",\n \\"transactiontype\\" \\"push\\",\n \\"amount\\" 1000,\n \\"servicetype\\" \\"sameday\\",\n \\"settlementdays\\" 0\n}" }, { "id" "400", "language" "400", "code" "{\\\n \\\\\\"errors\\\\\\" \[{\\\n \\\\\\"code\\\\\\" 2001,\\\n \\\\\\"message\\\\\\" \\\\\\"validation error\\\\\\"\\\n }]\\\n}" }, { "id" "401", "language" "401", "code" "{\\\n \\\\\\"errors\\\\\\" \[{\\\n \\\\\\"code\\\\\\" 3001,\\\n \\\\\\"message\\\\\\" \\\\\\"unauthorized\\\\\\"\\\n }]\\\n}" } ], "selectedlanguageid" "200" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "formdataparameters" \[], "bodydataparameters" \[ { "name" "originatorroutingnumber", "kind" "returned", "type" "string", "description" "aba routing number of a bank other than cross river", "" "aba routing number of a bank other than cross river" }, { "name" "originatorname", "kind" "returned", "type" "string", "description" "a name for the fictional person sending the payment maximum 35 characters ", "" "a name for the fictional person sending the payment maximum 35 characters " }, { "name" "originatoridentification", "kind" "returned", "type" "string", "description" "fictional id number maximum 10 digits regex ^\[a za z0 9^ ! \\\\ @'`()#\\"\\" \\\\]+{}| $%&, \\\\\\\\]+$", "" "fictional id number maximum 10 digits regex ^\[a za z0 9^ ! \\\\ @'`()#\\"\\" \\\\]+{}| $%&, \\\\\\\\]+$" }, { "name" "originatordata", "kind" "optional", "type" "string", "description" "some data about the fictional originator", "" "some data about the fictional originator" }, { "name" "receiveraccountnumber", "kind" "returned", "type" "string", "description" "a sandbox account number configured to receive ach payments", "" "a sandbox account number configured to receive ach payments" }, { "name" "receiveraccounttype", "kind" "returned", "type" "string", "description" "the type of account set up in sandbox \n checking\n savings\n generalledger\n loan", "" "the type of account set up in sandbox \n checking\n savings\n generalledger\n loan" }, { "name" "receivername", "kind" "returned", "type" "string", "description" "name on the sandbox account 35 character maximum ", "" "name on the sandbox account 35 character maximum " }, { "name" "receiveridentification", "kind" "optional", "type" "string", "description" "identification number of the receiver as it appears in the customer record maximum 15 digits regex ^\[a za z0 9^ ! \\\\ @'`()#\\"\\" \\\\]+{}| $%&, \\\\\\\\]+$", "" "identification number of the receiver as it appears in the customer record maximum 15 digits regex ^\[a za z0 9^ ! \\\\ @'`()#\\"\\" \\\\]+{}| $%&, \\\\\\\\]+$" }, { "name" "seccode", "kind" "returned", "type" "string", "description" "standard entry class (sec) code required by nacha for every ach transaction see the ach request and response code page \nfor the simulation we recommend using ppd ", "" "standard entry class (sec) code required by nacha for every ach transaction see the ach request and response code page \nfor the simulation we recommend using ppd " }, { "name" "description", "kind" "returned", "type" "string", "description" "description of the payment maximum 10 characters \nfor the simulation, we recommend \\"testing\\" as the description ", "" "description of the payment maximum 10 characters \nfor the simulation, we recommend \\"testing\\" as the description " }, { "name" "transactiontype", "kind" "returned", "type" "string", "description" "sending or requesting funds \n push (originator is sending funds)\n pull (originator is receiving funds)\nfor the simulation, use push ", "" "sending or requesting funds \n push (originator is sending funds)\n pull (originator is receiving funds)\nfor the simulation, use push " }, { "name" "amount", "kind" "returned", "type" "integer", "description" "dollar amount of the transaction in positive integral cents for example, $1 00 appears as 100 ", "" "dollar amount of the transaction in positive integral cents for example, $1 00 appears as 100 " }, { "name" "servicetype", "kind" "returned", "type" "string", "description" "when the payment completes \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" "extendeddetails", "kind" "optional", "type" "object", "description" "ach specific details \nif the transactiontype is pull and seccode is web you must include a paymenttype value in this object \nif the seccode is pos you must include a cardtransactiontype value \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, for example, purchase or refund" }, { "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 located" }, { "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" "serial number of the transaction" }, { "name" "transactiontime", "kind" "optional", "type" "string", "description" "transaction timestamp" } ], "" "optional", "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, for example, purchase or refund" }, { "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 located" }, { "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" "serial number of the transaction" }, { "name" "transactiontime", "kind" "optional", "type" "string", "description" "transaction timestamp" } ] }, { "name" "iatdetails", "kind" "optional", "type" "object", "description" "international ach details required if the seccode is iat \ndo not enter values for these attributes for any other seccode ", "children" \[ { "name" "originator", "kind" "optional", "type" "object", "description" "originator of the payment", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "originator street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "originator city full name 33 characters maximum \n" }, { "name" "state", "kind" "optional", "type" "string", "description" "originator state or province name 33 characters maximum " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "originator postal or zip code regular expression 32 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receiver", "kind" "optional", "type" "object", "description" "receiver bank details", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "receiver street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "receiver city full name 33 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "receiver state or province name 33 characters maximum \n" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "receiver postal or zip 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 originating financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "originating bank 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" "originating bank 2 letter iso country code" } ] }, { "name" "receivingbank", "kind" "optional", "type" "object", "description" "details of financial institution receiving the iat", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of receiving financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "receiving bank dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "receiving 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" "remittanceinfo1", "kind" "optional", "type" "string", "description" "additional iat information \na second field is available as remittanceinfo2 " }, { "name" "correspondentbank1", "kind" "optional", "type" "object", "description" "details of a correspondent (intermediary) bank, if there is one \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" "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" } ], "" "international ach details required if the seccode is iat \ndo not enter values for these attributes for any other seccode ", "schema" \[ { "name" "originator", "kind" "optional", "type" "object", "description" "originator of the payment", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "originator street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "originator city full name 33 characters maximum \n" }, { "name" "state", "kind" "optional", "type" "string", "description" "originator state or province name 33 characters maximum " }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "originator postal or zip code regular expression 32 characters maximum " }, { "name" "countrycode", "kind" "required", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receiver", "kind" "optional", "type" "object", "description" "receiver bank details", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "receiver street or post office box address 35 characters maximum " }, { "name" "city", "kind" "required", "type" "string", "description" "receiver city full name 33 characters maximum " }, { "name" "state", "kind" "optional", "type" "string", "description" "receiver state or province name 33 characters maximum \n" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "receiver postal or zip 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 originating financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "originating bank 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" "originating bank 2 letter iso country code" } ] }, { "name" "receivingbank", "kind" "optional", "type" "object", "description" "details of financial institution receiving the iat", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of receiving financial institution 35 characters maximum " }, { "name" "identification", "kind" "required", "type" "string", "description" "receiving bank dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "required", "type" "string", "description" "receiving 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" "remittanceinfo1", "kind" "optional", "type" "string", "description" "additional iat information \na second field is available as remittanceinfo2 " }, { "name" "correspondentbank1", "kind" "optional", "type" "object", "description" "details of a correspondent (intermediary) bank, if there is one \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" "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" "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 ", "" "optional" }, { "name" "settlementdays", "kind" "optional", "type" "integer", "description" "settlement days", "" "optional" } ] }, "response" \[ { "name" "originatorroutingnumber", "kind" "returned", "type" "string", "description" "aba routing number of a bank other than cross river" }, { "name" "originatorname", "kind" "returned", "type" "string", "description" "a name for the fictional person sending the payment" }, { "name" "originatoridentification", "kind" "returned", "type" "string", "description" "fictional id number" }, { "name" "originatordata", "kind" "returned", "type" "string", "description" "some data about the fictional originator" }, { "name" "receiveraccountnumber", "kind" "returned", "type" "string", "description" "a sandbox account number configured to receive ach payments" }, { "name" "receiveraccounttype", "kind" "returned", "type" "string", "description" "the type of account set up in sandbox \n checking\n savings\n generalledger\n loan" }, { "name" "receivername", "kind" "returned", "type" "string", "description" "name on the sandbox account" }, { "name" "receiveridentification", "kind" "returned", "type" "string", "description" "identification number of the receiver as it appears in the customer record" }, { "name" "seccode", "kind" "returned", "type" "string", "description" "standard entry class (sec) code required by nacha for every ach transaction see the ach request and response code page " }, { "name" "description", "kind" "returned", "type" "string", "description" "description of the payment" }, { "name" "transactiontype", "kind" "returned", "type" "string", "description" "sending or requesting funds \n push (originator is sending funds)\n pull (originator is receiving funds)" }, { "name" "amount", "kind" "returned", "type" "integer", "description" "dollar amount of the transaction in positive integral cents for example, $1 00 appears as 100 " }, { "name" "servicetype", "kind" "returned", "type" "string", "description" "when the payment completes \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" "extendeddetails", "kind" "returned", "type" "object", "description" "ach specific fields learn 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, for example, purchase or refund" }, { "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 located" }, { "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" "serial number of the transaction" }, { "name" "transactiontime", "kind" "optional", "type" "string", "description" "transaction timestamp" } ] }, { "name" "iatdetails", "kind" "returned", "type" "object", "description" "international ach details \nthis object is only returned for the iat seccode ", "children" \[ { "name" "originator", "kind" "optional", "type" "object", "description" "originator of the payment", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "originator street or post office box address" }, { "name" "city", "kind" "optional", "type" "string", "description" "originator city full name\n" }, { "name" "state", "kind" "optional", "type" "string", "description" "originator state or province name\n" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "originator postal or zip code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receiver", "kind" "optional", "type" "object", "description" "payment receiver details", "children" \[ { "name" "address", "kind" "required", "type" "string", "description" "receiver street or post office box address" }, { "name" "city", "kind" "optional", "type" "string", "description" "receiver city full name" }, { "name" "state", "kind" "optional", "type" "string", "description" "receiver state or province name" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "receiver postal or zip code" }, { "name" "countrycode", "kind" "optional", "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 originating financial institution" }, { "name" "identification", "kind" "optional", "type" "string", "description" "originating bank dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "optional", "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" "optional", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "receivingbank", "kind" "optional", "type" "object", "description" "details of financial institution receiving the iat", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of receiving financial institution" }, { "name" "identification", "kind" "optional", "type" "string", "description" "receiving bank dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "optional", "type" "string", "description" "receiving 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" "optional", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "remittanceinfo1", "kind" "required", "type" "string", "description" "additional iat information \na second field is available as remittanceinfo2 " }, { "name" "correspondentbank1", "kind" "optional", "type" "object", "description" "details of a correspondent (intermediary) bank, if there is one \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" }, { "name" "identification", "kind" "optional", "type" "string", "description" "dfi identification number, which is the first 8 digits of that financial institution's routing number" }, { "name" "idqualifier", "kind" "optional", "type" "string", "description" "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" "optional", "type" "string", "description" "2 letter iso country code" } ] }, { "name" "transactiontypecode", "kind" "optional", "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" "required", "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" "addenda", "kind" "returned", "type" "string", "description" "supplemental data to identify an account holder or provide information about the payment this may include details such as invoice numbers " }, { "name" "settlementdays", "kind" "returned", "type" "integer", "description" "settlement days" } ], "description" "", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "autogeneratedanchorslug" "endpoint v1paymentssimulated inbound originations", "legacyhash" "aflae6pa6qpwh1ruho54v" }