Wire transfer

{ "name" "endpoint /wires/v1/payments", "method" "post", "url" "https //sandbox crbcos com/wires/v1/payments", "description" "sends a single wire transfer payment ", "tab" "examples", "examples" { "languages" \[ { "id" "mtsrdsnj69g4mxievompv", "language" "curl", "code" "curl l 'https //sandbox crbcos com/wires/v1/payments' ^\n d '{\n \\"accountnumber\\" \\"2955057589\\",\n \\"businessfunctioncode\\" \\"ctr\\",\n \\"receiverroutingnumber\\" \\"026009593\\",\n \\"beneficiary\\" {\n \\"idcode\\" \\"d\\",\n \\"identifier\\" \\"316840684\\",\n \\"name\\" \\"stewie griffin\\",\n \\"address1\\" \\"31 spooner st\\",\n \\"address2\\" \\"quahog ri 33030\\",\n \\"address3\\" \\"us\\"\n },\n \\"beneficiaryreference\\" \\"gift\\",\n \\"originatortobeneficiary1\\" \\"happy birthday\\",\n \\"amount\\" 15000,\n \\"purpose\\" \\"testing\\",\n \\"clientidentifier\\" \\"05d73490 65ac 4725 98b6 cbf8252e52fe\\"\n}\n\n'", "customlabel" "" }, { "id" "m0ovvmc ufe3dfj423 bo", "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' '/wires/v1/payments',\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 \\\\\\"accountnumber\\\\\\" \\\\\\"2955057589\\\\\\",\\\r\\\n \\\\\\"businessfunctioncode\\\\\\" \\\\\\"ctr\\\\\\",\\\r\\\n \\\\\\"receiverroutingnumber\\\\\\" \\\\\\"026009593\\\\\\",\\\r\\\n \\\\\\"beneficiary\\\\\\" {\\\r\\\n \\\\\\"idcode\\\\\\" \\\\\\"d\\\\\\",\\\r\\\n \\\\\\"identifier\\\\\\" \\\\\\"316840684\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"stewie griffin\\\\\\",\\\r\\\n \\\\\\"address1\\\\\\" \\\\\\"31 spooner st\\\\\\",\\\r\\\n \\\\\\"address2\\\\\\" \\\\\\"quahog ri 33030\\\\\\",\\\r\\\n \\\\\\"address3\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"beneficiaryreference\\\\\\" \\\\\\"gift\\\\\\",\\\r\\\n \\\\\\"originatortobeneficiary1\\\\\\" \\\\\\"happy birthday\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 15000,\\\r\\\n \\\\\\"purpose\\\\\\" \\\\\\"testing\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"05d73490 65ac 4725 98b6 cbf8252e52fe\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "o 7efxdul0tolkos1v1 g", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/wires/v1/payments\\"\n\npayload = \\"{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2955057589\\\\\\",\\\r\\\n \\\\\\"businessfunctioncode\\\\\\" \\\\\\"ctr\\\\\\",\\\r\\\n \\\\\\"receiverroutingnumber\\\\\\" \\\\\\"026009593\\\\\\",\\\r\\\n \\\\\\"beneficiary\\\\\\" {\\\r\\\n \\\\\\"idcode\\\\\\" \\\\\\"d\\\\\\",\\\r\\\n \\\\\\"identifier\\\\\\" \\\\\\"316840684\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"stewie griffin\\\\\\",\\\r\\\n \\\\\\"address1\\\\\\" \\\\\\"31 spooner st\\\\\\",\\\r\\\n \\\\\\"address2\\\\\\" \\\\\\"quahog ri 33030\\\\\\",\\\r\\\n \\\\\\"address3\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"beneficiaryreference\\\\\\" \\\\\\"gift\\\\\\",\\\r\\\n \\\\\\"originatortobeneficiary1\\\\\\" \\\\\\"happy birthday\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 15000,\\\r\\\n \\\\\\"purpose\\\\\\" \\\\\\"testing\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"05d73490 65ac 4725 98b6 cbf8252e52fe\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\"\nheaders = {\n\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "87mpvcfqvi032eolf41cc", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/wires/v1/payments\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest body = \\"{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2955057589\\\\\\",\\\r\\\n \\\\\\"businessfunctioncode\\\\\\" \\\\\\"ctr\\\\\\",\\\r\\\n \\\\\\"receiverroutingnumber\\\\\\" \\\\\\"026009593\\\\\\",\\\r\\\n \\\\\\"beneficiary\\\\\\" {\\\r\\\n \\\\\\"idcode\\\\\\" \\\\\\"d\\\\\\",\\\r\\\n \\\\\\"identifier\\\\\\" \\\\\\"316840684\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"stewie griffin\\\\\\",\\\r\\\n \\\\\\"address1\\\\\\" \\\\\\"31 spooner st\\\\\\",\\\r\\\n \\\\\\"address2\\\\\\" \\\\\\"quahog ri 33030\\\\\\",\\\r\\\n \\\\\\"address3\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"beneficiaryreference\\\\\\" \\\\\\"gift\\\\\\",\\\r\\\n \\\\\\"originatortobeneficiary1\\\\\\" \\\\\\"happy birthday\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 15000,\\\r\\\n \\\\\\"purpose\\\\\\" \\\\\\"testing\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"05d73490 65ac 4725 98b6 cbf8252e52fe\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "yp ndyky5byoh3pbco8f3", "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/wires/v1/payments\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"accountnumber\\" \\"2955057589\\",`+\\"\n\\"+`\n \\"businessfunctioncode\\" \\"ctr\\",`+\\"\n\\"+`\n \\"receiverroutingnumber\\" \\"026009593\\",`+\\"\n\\"+`\n \\"beneficiary\\" {`+\\"\n\\"+`\n \\"idcode\\" \\"d\\",`+\\"\n\\"+`\n \\"identifier\\" \\"316840684\\",`+\\"\n\\"+`\n \\"name\\" \\"stewie griffin\\",`+\\"\n\\"+`\n \\"address1\\" \\"31 spooner st\\",`+\\"\n\\"+`\n \\"address2\\" \\"quahog ri 33030\\",`+\\"\n\\"+`\n \\"address3\\" \\"us\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n \\"beneficiaryreference\\" \\"gift\\",`+\\"\n\\"+`\n \\"originatortobeneficiary1\\" \\"happy birthday\\",`+\\"\n\\"+`\n \\"amount\\" 15000,`+\\"\n\\"+`\n \\"purpose\\" \\"testing\\",`+\\"\n\\"+`\n \\"clientidentifier\\" \\"05d73490 65ac 4725 98b6 cbf8252e52fe\\"`+\\"\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 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" "mtsrdsnj69g4mxievompv" }, "results" { "languages" \[ { "id" "qhmia1yj9zvp9mo9zqnhh", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"2c17d36d cb70 420d 9a16 b30100ddd39c\\",\n \\"accountnumber\\" \\"2955057589\\",\n \\"coretransactionid\\" \\"5449f04c 9dce 4d54 9873 b30100ddd39c\\",\n \\"referenceid\\" \\"ft86171667z\\",\n \\"direction\\" \\"outbound\\",\n \\"paymenttype\\" \\"transfer\\",\n \\"source\\" \\"api\\",\n \\"status\\" \\"created\\",\n \\"posting\\" \\"pending\\",\n \\"partnerauthorization\\" \\"notrequired\\",\n \\"partnerauthorization2\\" \\"notrequired\\",\n \\"enteredbyid\\" \\"b799951d47eb410d92b9da901b8ffa69\\",\n \\"amount\\" 15000,\n \\"currency\\" \\"usd\\",\n \\"purpose\\" \\"testing\\",\n \\"businessfunctioncode\\" \\"ctr\\",\n \\"typecode\\" \\"1000\\",\n \\"senderroutingnumber\\" \\"021214891\\",\n \\"sendername\\" \\"cross river bank\\",\n \\"senderreference\\" \\"ft86171667z\\",\n \\"receiverroutingnumber\\" \\"026009593\\",\n \\"receivername\\" \\"bk amer nyc \\",\n \\"originatingfi\\" {\n \\"idcode\\" \\"f\\",\n \\"identifier\\" \\"021214891\\",\n \\"name\\" \\"cross river bank\\",\n \\"address1\\" \\"400 kelby street\\",\n \\"address2\\" \\"fort lee, nj\\",\n \\"address3\\" \\"us\\"\n },\n \\"originator\\" {\n \\"identifier\\" \\"2955057589\\",\n \\"name\\" \\"originator name\\"\n },\n \\"beneficiary\\" {\n \\"idcode\\" \\"d\\",\n \\"identifier\\" \\"316840684\\",\n \\"name\\" \\"stewie griffin\\",\n \\"address1\\" \\"31 spooner st\\",\n \\"address2\\" \\"quahog ri 33030\\",\n \\"address3\\" \\"us\\"\n },\n \\"originatortobeneficiary1\\" \\"happy birthday\\",\n \\"beneficiaryreference\\" \\"gift\\",\n \\"wasreversed\\" false,\n \\"isinternational\\" false,\n \\"clientidentifier\\" \\"05d73490 65ac 4725 98b6 cbf8252e52fe\\",\n \\"createdat\\" \\"2025 06 19t09 27 38 7553761 04 00\\",\n \\"effectivedate\\" \\"2025 06 19t00 00 00 04 00\\",\n \\"originalpaymentid\\" \\"2c17d36d cb70 420d 9a16 b30100ddd39c\\",\n \\"partnerid\\" \\"1101a33d fbd9 4b9e b169 b29500f12407\\",\n \\"productid\\" \\"29f3022a ccfc 42eb aa8f b29500f13d00\\",\n \\"lastmodifiedat\\" \\"2025 06 19t09 27 38 7553761 04 00\\",\n \\"postingcode\\" \\"ok\\",\n \\"investigated\\" false,\n \\"isopaymenttype\\" \\"customercredittransfer\\"\n}" }, { "id" "1yo0myc ornxdwloa u5h", "language" "403", "code" "{\n \\"errors\\" \[\n {\n \\"code\\" 3001,\n \\"message\\" \\"origination payment amount exceeds user permissions\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "1yo0myc ornxdwloa u5h" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "originator account number" }, { "name" "originator", "kind" "optional", "type" "object", "description" "originator of the payment\n\nwhen calling the api, the originator on the outbound wire is either cross river by default or the name of the account, depending on the configuration of your product ", "" "originator of the payment\n\nwhen calling the api, the originator on the outbound wire is either cross river by default or the name of the account, depending on the configuration of your product ", "children" \[ { "name" "idcode", "kind" "optional", "type" "string", "description" "details of the financial institution sending the wire specifies the type of value in the identifier field that follows it 1 character see the list of id codes " }, { "name" "identifier", "kind" "optional", "type" "string", "description" "originator id" }, { "name" "name", "kind" "optional", "type" "string", "description" "originator name maximum 140 characters " }, { "name" "address1", "kind" "optional", "type" "string", "description" "details of the party sending the wire field of 35 characters usually used for the street address " }, { "name" "address2", "kind" "optional", "type" "string", "description" "details of the party sending the wire field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "details of the party sending the wire field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ], "schema" \[ { "name" "idcode", "kind" "optional", "type" "string", "description" "details of the financial institution sending the wire specifies the type of value in the identifier field that follows it 1 character see the list of id codes " }, { "name" "identifier", "kind" "optional", "type" "string", "description" "originator id" }, { "name" "name", "kind" "optional", "type" "string", "description" "originator name maximum 140 characters " }, { "name" "address1", "kind" "optional", "type" "string", "description" "details of the party sending the wire field of 35 characters usually used for the street address " }, { "name" "address2", "kind" "optional", "type" "string", "description" "details of the party sending the wire field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "details of the party sending the wire field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ] }, { "name" "businessfunctioncode", "kind" "required", "type" "string", "description" "the business purpose of the wire transfer the most common type is customer wire transfer (ctr) where the beneficiary isn't a bank see the full list of codes and descriptions ", "" "the business purpose of the wire transfer the most common type is customer wire transfer (ctr) where the beneficiary isn't a bank see the full list of codes and descriptions " }, { "name" "receiverroutingnumber", "kind" "required", "type" "string", "description" "the 9 digit fedwire routing number of the financial institution receiving the wire drawdown request the aba directory provides financial institution routing numbers ", "" "the 9 digit fedwire routing number of the financial institution receiving the wire drawdown request the aba directory provides financial institution routing numbers " }, { "name" "beneficiary", "kind" "required", "type" "object", "description" "entity receiving the funds", "children" \[ { "name" "idcode", "kind" "required", "type" "string", "description" "specifies the type of value in the identifier field that follows it maximum 1 character \nfor outbound payments, this field must contain a valid customer code, with the most common being \\"d\\" for demand deposit accounts \n\nplease refer to the \\"request and response code\\" section for the full list of valid customer codes " }, { "name" "identifier", "kind" "required", "type" "string", "description" "a number or string that provides unique identification, such as a driver's license number for an individual, or a fed routing number for an fi maximum 34 characters \nfor outbound payments, this is the beneficiary's account number \n" }, { "name" "name", "kind" "required", "type" "string", "description" "beneficiary name maximum 140 characters " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address \n" }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ], "schema" \[ { "name" "idcode", "kind" "required", "type" "string", "description" "specifies the type of value in the identifier field that follows it maximum 1 character \nfor outbound payments, this field must contain a valid customer code, with the most common being \\"d\\" for demand deposit accounts \n\nplease refer to the \\"request and response code\\" section for the full list of valid customer codes " }, { "name" "identifier", "kind" "required", "type" "string", "description" "a number or string that provides unique identification, such as a driver's license number for an individual, or a fed routing number for an fi maximum 34 characters \nfor outbound payments, this is the beneficiary's account number \n" }, { "name" "name", "kind" "required", "type" "string", "description" "beneficiary name maximum 140 characters " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address \n" }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ] }, { "name" "beneficiaryfi", "kind" "optional", "type" "object", "description" "bank receiving the wire transfer", "children" \[ { "name" "idcode", "kind" "required", "type" "string", "description" "specifies the type of value in the identifier field that follows it maximum 1 character \n\nfor outbound payments, the value for the beneficiary fi is f to indicate the bank fed routing number this field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverroutingnumber field \n\nrequired if idcode is not \\"f\\" fed routing number " }, { "name" "identifier", "kind" "required", "type" "string", "description" "a number or string that provides unique identification, such as a driver's license number for an individual, or a fed routing number for an fi maximum 34 characters \n\nfor outbound payments, enter the bank fed routing number for the beneficiary fi this field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverroutingnumber field \n\nrequired if idcode is not \\"f\\" fed routing number " }, { "name" "name", "kind" "required", "type" "string", "description" "beneficiary financial institution name maximum 140 characters \n\nrequired if idcode is not \\"f\\" fed routing number " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address \n\nmust include address1 if idcode is not a bic " }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ], "schema" \[ { "name" "idcode", "kind" "required", "type" "string", "description" "specifies the type of value in the identifier field that follows it maximum 1 character \n\nfor outbound payments, the value for the beneficiary fi is f to indicate the bank fed routing number this field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverroutingnumber field \n\nrequired if idcode is not \\"f\\" fed routing number " }, { "name" "identifier", "kind" "required", "type" "string", "description" "a number or string that provides unique identification, such as a driver's license number for an individual, or a fed routing number for an fi maximum 34 characters \n\nfor outbound payments, enter the bank fed routing number for the beneficiary fi this field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverroutingnumber field \n\nrequired if idcode is not \\"f\\" fed routing number " }, { "name" "name", "kind" "required", "type" "string", "description" "beneficiary financial institution name maximum 140 characters \n\nrequired if idcode is not \\"f\\" fed routing number " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address \n\nmust include address1 if idcode is not a bic " }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ] }, { "name" "intermediaryfi", "kind" "optional", "type" "object", "description" "intermediary bank involved in the transaction required when sending an international payment ", "children" \[ { "name" "idcode", "kind" "required", "type" "string", "description" "specifies the type of value in the identifier field that follows it maximum 1 character " }, { "name" "identifier", "kind" "required", "type" "string", "description" "a number or string that provides unique identification, such as a driver's license number for an individual, or a fed routing number for an fi maximum 34 characters \n\nin this object, enter an identifier for the intermediary bank involved with the wire transaction if the idcode is a fed routing number, the identifier must be a valid fed participant \n" }, { "name" "name", "kind" "required", "type" "string", "description" "intermediary financial institution name maximum 140 characters \n" }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address \n\nmust include address1 if idcode is not a bic " }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ], "schema" \[ { "name" "idcode", "kind" "required", "type" "string", "description" "specifies the type of value in the identifier field that follows it maximum 1 character " }, { "name" "identifier", "kind" "required", "type" "string", "description" "a number or string that provides unique identification, such as a driver's license number for an individual, or a fed routing number for an fi maximum 34 characters \n\nin this object, enter an identifier for the intermediary bank involved with the wire transaction if the idcode is a fed routing number, the identifier must be a valid fed participant \n" }, { "name" "name", "kind" "required", "type" "string", "description" "intermediary financial institution name maximum 140 characters \n" }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address \n\nmust include address1 if idcode is not a bic " }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code if address2 is supplied then address1 must also be supplied " }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire if address3 is supplied then address2 must also be supplied " } ] }, { "name" "beneficiaryreference", "kind" "optional", "type" "string", "description" "optional field for additional information 35 characters maximum ", "" "optional field for additional information 35 characters maximum " }, { "name" "originatortobeneficiary1", "kind" "optional", "type" "string", "description" "field for additional information from the originator to the beneficiary \n\n35 characters maximum \n\nyou can add information in up to 4 originator to beneficiary fields (originatortobeneficiary1, originatortobeneficiary2, originatortobeneficiary3, originatortobeneficiary4) ", "children" \[] }, { "name" "amount", "kind" "required", "type" "integer", "description" "dollar amount of wire transfer in positive integral cents for example, write $1 00 as 100 ", "children" \[] }, { "name" "purpose", "kind" "required", "type" "string", "description" "reason for the wire transfer, such as \\"daily settlement \\" also use this field if you submit multiple wires for the same amount, such as \\"1 of 2, 2 of 2 \\" this data is not included with the outgoing fedwire message maxmum 50 characters ", "" "reason for the wire transfer, such as \\"daily settlement \\" also use this field if you submit multiple wires for the same amount, such as \\"1 of 2, 2 of 2 \\" this data is not included with the outgoing fedwire message maxmum 50 characters " }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the payment id first appears in the initial response to the originate a payment request this id is in guid format " }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "cross river account number in cross river, depending on the account type, the number of digits will vary the first digit indicates the kind of account ", "children" \[] }, { "name" "coretransactionid", "kind" "optional", "type" "string", "description" "internal cross river unique id for the transaction", "children" \[] }, { "name" "referenceid", "kind" "optional", "type" "string", "description" "unique reference id for the payment the reference id always begins with the first letter of the rail for wires the reference id starts with 'w' ", "children" \[] }, { "name" "fedbatchid", "kind" "optional", "type" "string", "description" "unique identifier in guid format for the federal reserve batch the payment went out on (or came in on for inbound payments)", "children" \[] }, { "name" "fedbatchsequence", "kind" "optional", "type" "integer", "description" "sequence number of payment in batch", "children" \[] }, { "name" "direction", "kind" "optional", "type" "string", "description" "inbound or outbound", "children" \[] }, { "name" "paymenttype", "kind" "optional", "type" "string", "description" "transfer, drawdown, drawdownresponse, servicemessage, reversal", "children" \[] }, { "name" "source", "kind" "optional", "type" "string", "description" "method used to send payment instructions phone, fax, email, file, api, partner portal, ops portal ", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "payment status created, pending, hold, batched, processing, completed, rejected, canceled, blocked", "children" \[] }, { "name" "posting", "kind" "optional", "type" "string", "description" "posting status pending, posted, failed, canceled", "children" \[] }, { "name" "rejectionreason", "kind" "optional", "type" "string", "description" "rejected because ofaccancel, unabletodetermine, ofacconfirmed, ofacunconfirmed, other", "children" \[] }, { "name" "blockedreason", "kind" "optional", "type" "string", "description" "blocked because ofacmatch, other", "children" \[] }, { "name" "partnerauthorization", "kind" "optional", "type" "string", "description" "partner authorization for out of band payment requests notrequired, pending , approved, canceled", "children" \[] }, { "name" "authorizedat", "kind" "optional", "type" "string", "description" "date and time the wire was authorized in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "authorizedbyid", "kind" "optional", "type" "string", "description" "cross river user id of the partner user who authorizes the wire", "children" \[] }, { "name" "authorizedbyname", "kind" "optional", "type" "string", "description" "cross river username of the partner user who authorizes the wire", "children" \[] }, { "name" "partnerauthorization2", "kind" "optional", "type" "string", "description" "second partner authorization for out of band payment requests notrequired, pending , approved, canceled", "children" \[] }, { "name" "authorizedat2", "kind" "optional", "type" "string", "description" "date and time the wire was authorized in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "authorizedbyid2", "kind" "optional", "type" "string", "description" "cross river user id of the partner user who authorizes the wire", "children" \[] }, { "name" "authorizedbyname2", "kind" "optional", "type" "string", "description" "cross river username of the partner user who authorizes the wire", "children" \[] }, { "name" "amount", "kind" "optional", "type" "integer", "description" "dollar amount of wire transfer in positive integral cents for example, write $1 00 as 100 ", "children" \[] }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency of funds transfer", "children" \[] }, { "name" "purpose", "kind" "optional", "type" "string", "description" "reason for the wire transfer, such as \\"daily settlement \\" also use this field if you submit multiple wires for the same amount, such as \\"1 of 2, 2 of 2 \\" this data is not included with the outgoing fedwire message ", "children" \[] }, { "name" "imad", "kind" "optional", "type" "string", "description" "input messaging accountability data a combination of a date, source identifier, and sequence number assigned to a fedwire message when it is processed by the federal reserve bank funds transfer application unique to the payment ", "children" \[] }, { "name" "omad", "kind" "optional", "type" "string", "description" "output messaging accountability data a combination of a date, destination identifier, and sequence number assigned to a fedwire message when it is processed by the federal reserve bank funds transfer application ", "children" \[] }, { "name" "businessfunctioncode", "kind" "optional", "type" "string", "description" "the business purpose of the wire transfer the most common type is customer wire transfer (ctr) where the beneficiary isn't a bank see the full list of codes and descriptions ", "children" \[] }, { "name" "typecode", "kind" "optional", "type" "string", "description" "the type code value provides information about the type of wire transfer sent (type code, first 2 digits) and more details about the transfer (subtype code, second 2 digits) ", "children" \[] }, { "name" "senderroutingnumber", "kind" "optional", "type" "string", "description" "fedwire routing number for the sender's bank", "children" \[] }, { "name" "sendername", "kind" "optional", "type" "string", "description" "entity sending the wire", "children" \[] }, { "name" "senderreference", "kind" "optional", "type" "string", "description" "sender assigned reference number 35 characters maximum ", "children" \[] }, { "name" "receiverroutingnumber", "kind" "optional", "type" "string", "description" "the 9 digit fedwire routing number of the financial institution receiving the wire drawdown request the aba directory provides financial institution routing numbers ", "children" \[] }, { "name" "receivername", "kind" "optional", "type" "string", "description" "name of the fi receiving the funds", "children" \[] }, { "name" "originatingfi", "kind" "optional", "type" "object", "description" "details of the financial institution sending the wire", "children" \[ { "name" "idcode", "kind" "optional", "type" "string", "description" "specifies the type of value in the identifier field that follows it 1 character see the list of id codes " }, { "name" "identifier", "kind" "optional", "type" "string", "description" "identifier at the financial institution sending the wire" }, { "name" "name", "kind" "optional", "type" "string", "description" "name of the originating financial institution" }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address" }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code" }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire" } ] }, { "name" "originator", "kind" "optional", "type" "object", "description" "details of the party sending the wire", "children" \[ { "name" "idcode", "kind" "optional", "type" "string", "description" "specifies the type of value in the identifier field that follows it 1 character see the list of id codes " }, { "name" "identifier", "kind" "optional", "type" "string", "description" "identifier for the party sending the wire for outbound payments where originator details are submitted with the payment request, this is the customer account number otherwise, the system automatically populates this field " }, { "name" "name", "kind" "optional", "type" "string", "description" "originator name " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address" }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code" }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire" } ] }, { "name" "intermediaryfi", "kind" "optional", "type" "object", "description" "details of any intermediary bank involved in the wire transaction not all wire transfers use an intermediary fi ", "children" \[ { "name" "idcode", "kind" "optional", "type" "string", "description" "specifies the type of value in the identifier field that follows it 1 character see the list of id codes " }, { "name" "identifier", "kind" "optional", "type" "string", "description" "identifier for the intermediary bank involved with the wire transaction " }, { "name" "name", "kind" "optional", "type" "string", "description" "intermediary financial institution name " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address" }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code" }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire" } ] }, { "name" "beneficiaryfi", "kind" "optional", "type" "object", "description" "details of the financial institution receiving the wire", "children" \[ { "name" "idcode", "kind" "optional", "type" "string", "description" "specifies the type of value in the identifier field that follows it 1 character see the list of id codes \n\nfor outbound payments, the value for the beneficiary fi is f to indicate the bank fed routing number this field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverroutingnumber field " }, { "name" "identifier", "kind" "optional", "type" "string", "description" "identifier for the bank receiving the wire for outbound payments, this is the bank fed routing number this field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverroutingnumber field " }, { "name" "name", "kind" "optional", "type" "string", "description" "beneficiary financial institution name maximum 140 characters " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address" }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code" }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire" } ] }, { "name" "beneficiary", "kind" "optional", "type" "object", "description" "details of the party receiving the wire", "children" \[ { "name" "idcode", "kind" "optional", "type" "string", "description" "identifier code for the party receiving the wire for outbound payments, this is \\"d\\" to indicate a deposit account " }, { "name" "identifier", "kind" "optional", "type" "string", "description" "identifier for the party receiving the wire for outbound payments, this is the beneficiary's account number " }, { "name" "name", "kind" "optional", "type" "string", "description" "beneficiary name maximum 140 characters " }, { "name" "address1", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the street address" }, { "name" "address2", "kind" "optional", "type" "string", "description" "field of 35 characters usually used for the city, state, and postal code" }, { "name" "address3", "kind" "optional", "type" "string", "description" "field of 35 characters for any information, for example, country code or information related to the wire" } ] }, { "name" "originatortobeneficiary1", "kind" "optional", "type" "string", "description" "field for additional information from the originator to the beneficiary ", "children" \[] }, { "name" "beneficiaryreference", "kind" "optional", "type" "string", "description" "optional field for additional information 35 characters maximum ", "children" \[] }, { "name" "receiptdate", "kind" "optional", "type" "string", "description" "month and day the wire was received in the format mmdd", "children" \[] }, { "name" "receipttime", "kind" "optional", "type" "string", "description" "time the wire was received, in the format hhmm", "children" \[] }, { "name" "wasreversed", "kind" "optional", "type" "boolean", "description" "true if the payment was reversed, otherwise false", "children" \[] }, { "name" "isinternational", "kind" "optional", "type" "boolean", "description" "true if the payment is international, otherwise false", "children" \[] }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "use this attribute to add your own unique identifying string to a payment call or cos record this attribute is useful for idempotency purposes ", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time the payment was created in the system in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "releasedat", "kind" "optional", "type" "string", "description" "date and time the payment was released in a distribution to the fed in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "processedat", "kind" "optional", "type" "string", "description" "date and time the payment was processed by cross river in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "canceledat", "kind" "optional", "type" "string", "description" "date and time the payment was canceled", "children" \[] }, { "name" "rejectedat", "kind" "optional", "type" "string", "description" "date and time the payment was rejected in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "blockedat", "kind" "optional", "type" "string", "description" "date and time the payment was blocked by bsa/aml in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "effectivedate", "kind" "optional", "type" "string", "description" "business date on which the payment is effective", "children" \[] }, { "name" "completedat", "kind" "optional", "type" "string", "description" "date and time the payment was systemically completed this can only occur after the payment has successfully posted to the account in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "postedat", "kind" "optional", "type" "string", "description" "date and time the payment was posted to the cross river account in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "originalpaymentid", "kind" "optional", "type" "string", "description" "payment id of a previously sent wire that was reversed otherwise, the same as the payment id ", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your id in the cross river system this id is in guid format ", "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 in this case, the cross river account involved in the payment more about product ids ", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified ", "children" \[] }, { "name" "postingcode", "kind" "optional", "type" "string", "description" "includes ok (posted), res (account restricted), nsf (insufficient funds in the account sending the wire)", "children" \[] } ] }