Send payment

relevant webhooks for this endpoint be sure you have docid\ bn5xtgkjogbe ctwomcbs for these webhooks docid\ o9fuc2dkpczcl1h4yichr docid\ o9fuc2dkpczcl1h4yichr docid\ o9fuc2dkpczcl1h4yichr docid\ o9fuc2dkpczcl1h4yichr docid\ o9fuc2dkpczcl1h4yichr docid\ o9fuc2dkpczcl1h4yichr docid\ o9fuc2dkpczcl1h4yichr api reference originates a cross border money transfer you must get a quote id using the docid\ onbkgebihvb4ihvb1hakl api the quote id is returned in the id field in the response to that call quote ids submitted in request are typically only valid for 60 seconds { "name" "endpoint /international/v1/payments", "method" "post", "url" "https //sandbox crbcos com/international/v1/payments", "description" "originates a cross border money transfer ", "tab" "examples", "examples" { "languages" \[ { "id" "l44lybpekpvvxd2s4itgr", "language" "curl", "code" "curl location 'https //sandbox crbcos com/international/v1/payments' \\\\\n data '{\n \\"quoteid\\" \\"1333dc9d ec3d 40f0 8a8e b39b007d581b\\"\n}'", "customlabel" "" }, { "id" "2zw9pmcfkgqgvkmpc zz1", "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' '/international/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 \\\\\\"quoteid\\\\\\" \\\\\\"f710a42a e03a 47b8 a415 b3050061085e\\\\\\"\\\r\\\n}\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "ytvnprg s9zng3kp9wt4k", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/international/v1/payments\\"\n\npayload = \\"{\\\r\\\n \\\\\\"quoteid\\\\\\" \\\\\\"f710a42a e03a 47b8 a415 b3050061085e\\\\\\"\\\r\\\n}\\"\nheaders = {}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "q9wgw9osncsqcp68udz0n", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/international/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 \\\\\\"quoteid\\\\\\" \\\\\\"f710a42a e03a 47b8 a415 b3050061085e\\\\\\"\\\r\\\n}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "uamstop2fdbraiudxn9ci", "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/international/v1/payments\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"quoteid\\" \\"f710a42a e03a 47b8 a415 b3050061085e\\"`+\\"\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" "l44lybpekpvvxd2s4itgr" }, "results" { "languages" \[ { "id" " qq8 titi2nzdm7phxhyr", "language" "200", "code" "{\n \\"id\\" \\"5962aa43 a31e 42e5 950d b39b007d67d6\\",\n \\"partnerid\\" \\"19222b81 0e1e 452d a842 b2f1011c16f3\\",\n \\"productid\\" \\"57146944 b145 4326 884d b2f700ecf688\\",\n \\"quoteid\\" \\"1333dc9d ec3d 40f0 8a8e b39b007d581b\\",\n \\"fromcurrency\\" \\"usd\\",\n \\"tocurrency\\" \\"gbp\\",\n \\"fromamount\\" 500,\n \\"toamount\\" 394,\n \\"accountnumber\\" \\"158560897007\\",\n \\"estimateddeliverydate\\" \\"11/20/2025 12 00 00 am\\",\n \\"originator\\" {\n \\"entityname\\" \\"cross river bank\\",\n \\"firstname\\" \\"\\",\n \\"lastname\\" \\"\\",\n \\"fullname\\" \\"cross river bank\\",\n \\"address\\" \\"885 teaneck road\\",\n \\"city\\" \\"teaneck\\",\n \\"state\\" \\"nj\\",\n \\"postalcode\\" \\"07666\\",\n \\"countrycode\\" \\"us\\",\n \\"entitytype\\" \\"company\\",\n \\"birthdate\\" \\"2008 06 23\\",\n \\"identificationtype\\" \\"incorporationnumber\\",\n \\"identificationvalue\\" \\"0400170263\\"\n },\n \\"beneficiary\\" {\n \\"firstname\\" \\"jon\\",\n \\"lastname\\" \\"smith\\",\n \\"fullname\\" \\"jon smith\\",\n \\"birthdate\\" \\"2001 06 18t00 00 00 04 00\\",\n \\"address\\" \\"1 street\\",\n \\"city\\" \\"winfield\\",\n \\"postalcode\\" \\"gb12345\\",\n \\"countrycode\\" \\"gb\\",\n \\"entitytype\\" \\"individual\\"\n },\n \\"beneficiaryfi\\" {\n \\"bankname\\" \\"bank uk\\",\n \\"bankcountrycode\\" \\"gb\\",\n \\"bankaddress\\" \\"1 avenue\\",\n \\"bankaccounttype\\" \\"checking\\",\n \\"routingcodetype1\\" \\"sortcode\\",\n \\"routingcodevalue1\\" \\"123456789\\",\n \\"routingcodetype2\\" \\"aba\\",\n \\"routingcodevalue2\\" \\"123456789\\",\n \\"bicswift\\" \\"tgclgb99\\",\n \\"iban\\" \\"gb33bukb20201555555555\\"\n },\n \\"status\\" \\"created\\",\n \\"purpose\\" \\"srv\\",\n \\"paymenttype\\" \\"transfer\\",\n \\"direction\\" \\"outbound\\",\n \\"priority\\" true,\n \\"feeamount\\" 100,\n \\"feecurrency\\" \\"usd\\",\n \\"source\\" \\"api\\",\n \\"createdat\\" \\"2025 11 20t02 36 35 2730121 05 00\\",\n \\"lastmodifiedat\\" \\"2025 11 20t02 36 35 2730121 05 00\\",\n \\"limitseligibleon\\" \\"2025 11 20t02 36 35 2730121 05 00\\"\n}\n", "customlabel" "" }, { "id" "qjrefapukavxc3uc1lwa5", "language" "400", "code" "{\n \\"errors\\" \[\n {\n \\"code\\" 2404,\n \\"message\\" \\"quote has expired\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" " qq8 titi2nzdm7phxhyr" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "quoteid", "kind" "required", "type" "string", "description" "id in guid format received in the response to the quote call the quote id is valid for a limited time, typically 60 seconds ", "" "id in guid format received in the response to the quote call the quote id is valid for a limited time, typically 60 seconds " }, { "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" "payment id this id first appears as the value for this attribute in the response to the originate a payment call this id is in guid format " }, { "name" "referencepaymentid", "kind" "optional", "type" "string", "description" "a unique id of a transaction that is associated with the payment for example, a return ", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique 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 ", "children" \[] }, { "name" "quoteid", "kind" "optional", "type" "string", "description" "the id of the quote used to execute the money transfer, found in the id field of the response to the create a payment quote call \n\nthis id is in guid format ", "children" \[] }, { "name" "fromcurrency", "kind" "optional", "type" "string", "description" "currency the payment is sent in", "children" \[] }, { "name" "tocurrency", "kind" "optional", "type" "string", "description" "currency the payment is received in", "children" \[] }, { "name" "fromamount", "kind" "optional", "type" "integer", "description" "the amount in usd to be transferred", "children" \[] }, { "name" "toamount", "kind" "optional", "type" "integer", "description" "the amount in the specified currency to be received", "children" \[] }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number of the sending cross river account", "children" \[] }, { "name" "originator", "kind" "optional", "type" "object", "description" "the individual or company sending the payment", "children" \[ { "name" "firstname", "kind" "optional", "type" "string", "description" "first name of the originator of the funds required if entitytype is individual" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "last name of the originator of the funds required if entitytype is individual" }, { "name" "companyname", "kind" "optional", "type" "string", "description" "name of the originator company required if entitytype is company " }, { "name" "email", "kind" "optional", "type" "string", "description" "originator email address, whether a company or an individual" }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "if entitytype is company, date of registration if entitytype is individual, date of birth the date is this format \\"yyyy mm dd\\"" }, { "name" "address", "kind" "optional", "type" "string", "description" "originator street address" }, { "name" "city", "kind" "optional", "type" "string", "description" "city where the originator is based" }, { "name" "stateprovince", "kind" "optional", "type" "string", "description" "originator state or province" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "originator postal or zip code" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "two letter iso country code for a company entity, the country where it's registered for an individual, the country where they're based " }, { "name" "entitytype", "kind" "optional", "type" "string", "description" "legal status of the entity, whether beneficiary or originator \n\n individual\n company\n\nthe default value is individual " } ] }, { "name" "beneficiary", "kind" "optional", "type" "object", "description" "the individual or company who gets the payment", "children" \[ { "name" "firstname", "kind" "optional", "type" "string", "description" "first name of the beneficiary of the funds required if entitytype is individual" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "last name of the beneficiary of the funds required if entitytype is individual" }, { "name" "companyname", "kind" "optional", "type" "string", "description" "name of the beneficiary company required if entitytype is company " }, { "name" "email", "kind" "optional", "type" "string", "description" "beneficiary's email address, whether a company or an individual" }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "if entitytype is company, date of registration if entitytype is individual, date of birth the date and time are in this format \\"yyyy mm dd\\"" }, { "name" "address", "kind" "optional", "type" "string", "description" "complete beneficiary street address" }, { "name" "city", "kind" "optional", "type" "string", "description" "beneficiary city" }, { "name" "stateprovince", "kind" "optional", "type" "string", "description" "beneficiary state or province" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "beneficiary postal or zip code " }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "two letter iso country code for a company entity, the country where it's registered for an individual, the country where they're based " }, { "name" "entitytype", "kind" "optional", "type" "string", "description" "legal status of the entity, whether beneficiary or originator \n\n individual\n company\n\nthe default value is individual " } ] }, { "name" "beneficiaryfi", "kind" "optional", "type" "object", "description" "details of the beneficiary's financial institution (where the payment goes)", "children" \[ { "name" "bankname", "kind" "optional", "type" "string", "description" "name of the beneficiary's bank" }, { "name" "bankcountrycode", "kind" "optional", "type" "string", "description" "two letter code for the country where the beneficiary's bank account is held" }, { "name" "bankaddress", "kind" "optional", "type" "string", "description" "street address of the beneficiary's bank" }, { "name" "bankaccounttype", "kind" "optional", "type" "string", "description" "beneficiary bank account type \n\n checking\n savings" }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number receiving the payment maximum n characters " }, { "name" "routingcodetype1", "kind" "optional", "type" "string", "description" "local payment routing system type if supplied, you must also give the actual code for routingcodevalue1 \n\n sortcode (uk, ireland)\n aba (united states)\n bsbcode (australia)\n institutionno\n bankcode\n branchcode\n clabe (mexico)\n cnaps (china)\n ifsc" }, { "name" "routingcodevalue1", "kind" "optional", "type" "string", "description" "routing code of the routing code type \n\nrequired if you supply a value for routingcodetype1 " }, { "name" "routingcodetype2", "kind" "optional", "type" "string", "description" "sometimes certain corridors will require 2 routing codes in that case, use this attribute for the second code type if supplied, you must also give the actual code for routingcodevalue2 \n\n sortcode (uk, ireland)\n aba (united states)\n bsbcode (australia)\n institutionno\n bankcode\n branchcode\n clabe (mexico)\n cnaps (china)\n ifsc" }, { "name" "routingcodevalue2", "kind" "optional", "type" "string", "description" "routing code of the routing code type \nrequired if you supplied a value for routingcodetype2 " }, { "name" "bicswift", "kind" "optional", "type" "string", "description" "bic/swift code of the beneficiary fi" }, { "name" "iban", "kind" "optional", "type" "string", "description" "iban number of the beneficiary fi" } ] }, { "name" "status", "kind" "optional", "type" "string", "description" "status of the payment object\n\n created\n pending\n processing\n hold\n canceled\n completed\n failed\n rejected\n blocked", "children" \[] }, { "name" "purpose", "kind" "optional", "type" "string", "description" "a 1 12 character code that indicates the reason for a transaction this code is required for certain markets (countries) ", "children" \[] }, { "name" "rejectreason", "kind" "optional", "type" "string", "description" "reason for rejecting the payment", "children" \[] }, { "name" "blockedreason", "kind" "optional", "type" "string", "description" " ofactmatch\n other", "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" "paymentdate", "kind" "optional", "type" "string", "description" "the date and time of anticipated payment delivery, in the format yyyy mm ddthh\ mm\ ss\[ mmm] \n\npayment delivery times cannot be guaranteed ", "children" \[] }, { "name" "paymenttype", "kind" "optional", "type" "string", "description" "tell you whether this is an original transfer or return payment \n\n transfer\n return", "children" \[] }, { "name" "priority", "kind" "optional", "type" "boolean", "description" "true if the transfer is via swift otherwise false if you don't supply a value, the default is false ", "children" \[] }, { "name" "feeamount", "kind" "optional", "type" "integer", "description" "transaction fee amount", "children" \[] }, { "name" "feecurrency", "kind" "optional", "type" "string", "description" "currency used for the fee", "children" \[] }, { "name" "source", "kind" "optional", "type" "string", "description" "the source of the request to send a cross border payment \n\n api\n partnerportal\n opsportal", "children" \[] }, { "name" "postingstatus", "kind" "optional", "type" "string", "description" " pending\n posted\n failed\n canceled\n authorized\n notapplicable", "children" \[] }, { "name" "coretransactionid", "kind" "optional", "type" "string", "description" "unique cross river identifier for the core transaction this id is in guid format ", "children" \[] }, { "name" "feetransactionid", "kind" "optional", "type" "string", "description" "unique cross river identifier for the transaction free debited from the partners account this id is in guid format ", "children" \[] }, { "name" "spreadfeetransactionid", "kind" "optional", "type" "string", "description" "unique cross river identifier for the spread free debited from the partners account this id is in guid format ", "children" \[] }, { "name" "partnerspreadfeetransactionid", "kind" "optional", "type" "string", "description" "unique cross river identifier for the markup that can be levied on the spread fee by the partner to their client ", "children" \[] }, { "name" "partnertransactionfeetransactionid", "kind" "optional", "type" "string", "description" "unique cross river identifier for the markup that can be levied on the transaction fee by the partner to their client ", "children" \[] }, { "name" "canceledat", "kind" "optional", "type" "string", "description" "date and time the payment was canceled \n\nin 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 \n\nin this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "completedat", "kind" "optional", "type" "string", "description" "date and time the payment completed \n\nin this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "date and time the payment was created \n\nin 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 \n\nin this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "internal cross river value date and time the database entry was last modified in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "limitseligibleon", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "purposecode", "kind" "optional", "type" "string", "description" "required for payments to india (inr), malaysia (myr), and united arab emirates (aed) check our payment purpose codes page for additional details ", "children" \[] }, { "name" "invoicenumber", "kind" "optional", "type" "string", "description" "necessary when making trade related inr payments, check our payment purpose codes page for additional details 1 30 characters ", "children" \[] }, { "name" "invoicedate", "kind" "optional", "type" "string", "description" "necessary when making trade related inr payments, check our payment purpose codes page for additional details iso 8601 format (yyyy mm dd) ", "children" \[] } ], "hastryitout" false, "autogeneratedanchorslug" "endpoint internationalv1payments", "legacyhash" "3kjpxkyoprvaiv1b90w1s" } for additional information, refer to our docid\ mz2n7dqz5peg7vglhdowm tutorial