Cancel payment

relevant webhooks for this endpoint be sure you have registered docid\ bn5xtgkjogbe ctwomcbs for this webhook international payment canceled docid\ o9fuc2dkpczcl1h4yichr api reference cancels a cross border money transfer this must be sent during a 30 minute window which starts once the send payment endpoint has been sent the input id is generated by the send payment docid\ evbwhqlrgzlamld2hrwvd api it is the first id (payment id) in the response quote ids submitted in request are typically only valid for 60 seconds { "name" "endpoint /international/v1/payments/{id}/cancel", "method" "post", "url" "https //sandbox crbcos com/internationalpost/v1/payments/{id}/cancel", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "pwxzxfz8u6eucpay8tibn", "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/1d2c2103 149f 44dc 91eb b4390086f885/cancel',\n 'headers' {\n 'authorization' 'bearer \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 \nreq end();" }, { "id" "ik3yo5gifbd9lpnkgbhgf", "language" "python", "code" "import requests\n \nurl = \\"https //sandbox crbcos com/international/v1/payments/1d2c2103 149f 44dc 91eb b4390086f885/cancel%22\n \npayload = {}\nheaders = {\n 'authorization' 'bearer '\n}\n \nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n \nprint(response text)" }, { "id" "e47b637ytj1xr6nf gd6v", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n \nurl = uri(\\"https //sandbox crbcos com/international/v1/payments/1d2c2103 149f 44dc 91eb b4390086f885/cancel%22)\n \nhttps = net http new(url host, url port)\nhttps use ssl = true\n \nrequest = net http post new(url)\nrequest\[\\"authorization\\"] = \\"bearer \\"\n \nresponse = https request(request)\nputs response read body" }, { "id" "f5wlotdrheknifkhuvuzu", "language" "go", "code" "package main\n \nimport (\n \\"fmt\\"\n \\"net/http\"\n \\"io\\"\n)\n \nfunc main() {\n \n url = \\"https //sandbox crbcos com/international/v1/payments/1d2c2103 149f 44dc 91eb b4390086f885/cancel%22\n method = \\"post\\"\n \n client = \&http client {\n }\n req, err = http newrequest(method, url, nil)\n \n if err != nil {\n fmt println(err)\n return\n }\n req header add(\\"authorization\\", \\"bearer \\")\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}" }, { "id" "vqlanivbwqqm4sp1b0xsy", "language" "curl", "code" "url location request post 'https //sandbox crbcos com/international/v1/payments/1d2c2103 149f 44dc 91eb b4390086f885/cancel" } ], "selectedlanguageid" "vqlanivbwqqm4sp1b0xsy" }, "results" { "languages" \[ { "id" " qq8 titi2nzdm7phxhyr", "language" "200", "code" "{\n \\"id\\" \\"1d2c2103 149f 44dc 91eb b4390086f885\\",\n \\"partnerid\\" \\"19222b81 0e1e 452d a842 b2f1011c16f3\\",\n \\"productid\\" \\"57146944 b145 4326 884d b2f700ecf688\\",\n \\"quoteid\\" \\"e4b4bd78 a9d2 4a2c b6f2 b4390086dd1e\\",\n \\"fromcurrency\\" \\"usd\\",\n \\"tocurrency\\" \\"gbp\\",\n \\"fromamount\\" 500,\n \\"toamount\\" 374,\n \\"accountnumber\\" \\"383773221643\\",\n \\"estimateddeliverydate\\" \\"4/27/2026 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 \\"companyname\\" \\"acme\\",\n \\"fullname\\" \\"acme\\",\n \\"birthdate\\" \\"2001 06 18t00 00 00 04 00\\",\n \\"address\\" \\"1 street\\",\n \\"city\\" \\"winfield\\",\n \\"postalcode\\" \\"gb12345\\",\n \\"countrycode\\" \\"gb\\",\n \\"entitytype\\" \\"company\\"\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\\" \\"canceled\\",\n \\"purpose\\" \\"srv\\",\n \\"paymenttype\\" \\"transfer\\",\n \\"direction\\" \\"outbound\\",\n \\"priority\\" true,\n \\"feeamount\\" 0,\n \\"feecurrency\\" \\"usd\\",\n \\"source\\" \\"api\\",\n \\"postingstatus\\" \\"posted\\",\n \\"postingcode\\" \\"ok\\",\n \\"coretransactionid\\" \\"ed84039f ff16 4300 b90c b4390086f940\\",\n \\"vendorspreadfeetransactionid\\" \\"534a894b 5ee7 47c0 a532 b43900876f02\\",\n \\"spreadfeetransactionid\\" \\"07af70e8 5f34 493e be40 b43900876f02\\",\n \\"canceledat\\" \\"2026 04 27t04 16 48 6803203 04 00\\",\n \\"processedat\\" \\"2026 04 27t04 11 25 44 04 00\\",\n \\"createdat\\" \\"2026 04 27t04 11 24 8166667 04 00\\",\n \\"lastmodifiedat\\" \\"2026 04 27t04 16 48 6991424 04 00\\",\n \\"limitseligibleon\\" \\"2026 04 27t04 11 24 817 04 00\\"\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" \[ { "name" "id", "kind" "required", "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 ", "" "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 " } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "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" "fullname", "kind" "optional", "type" "string", "description" "name of the originator company required if entitytype is company " }, { "name" "address", "kind" "optional", "type" "string", "description" "originator street address" }, { "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" "state", "kind" "optional", "type" "string", "description" "originator state " }, { "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" "entityname", "kind" "optional", "type" "string", "description" "name of the company " }, { "name" "identificationtype", "kind" "optional", "type" "string", "description" " none \n driverslicense\n ssn \n greencard \n passport \n visa \n matriculaconsular \n registrofederaldecontribuyentes\n claveunicaderegistrodepoblacion \n credentialdeelector\n socialinsurancenumber \n citizenshippapers\n driverslicensecanadian \n existingcreditcarddetails\n nationalid\n incorporationnumber\n other" }, { "name" "identificationvalue", "kind" "optional", "type" "string", "description" "" } ] }, { "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" "fullname", "kind" "optional", "type" "string", "description" "" } ] }, { "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 50 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" " ofacmatch\n other", "children" \[] }, { "name" "statusreason", "kind" "optional", "type" "string", "description" "", "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" "direction", "kind" "optional", "type" "string", "description" "this can be inbound or outbound ", "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" "postingcode", "kind" "optional", "type" "string", "description" "", "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" "vendorspreadfeetransactionid", "kind" "optional", "type" "string", "description" "unique cross river identifier for the markup that can be levied on the spread fee by the vendor to their client ", "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" "vendortransactionfeetransactionid", "kind" "optional", "type" "string", "description" "unique cross river identifier for the markup that can be levied on the transaction fee by the vendor 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 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 in 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 in 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 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" "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 internationalv1paymentsidcancel", "legacyhash" "3kjpxkyoprvaiv1b90w1s" } for additional information, refer to our international payments docid\ mz2n7dqz5peg7vglhdowm tutorial