Cancel request

relevant webhooks for this endpoint be sure you have docid\ bn5xtgkjogbe ctwomcbs for this webhook docid\ ffgq2ohyebwpzn2old6mc api reference cancels a payment request if a credit transfer or payment request response has not been received { "name" "endpoint /rtp/v1/payments/{id}/payment request/cancel", "method" "post", "url" "https //sandbox crbcos com/rtp/v1/payments/{id}/payment request/cancel", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "oxrdniu1 dt00zxdeyi99", "language" "curl", "code" "curl location globoff '/v1/payments/{id}/payment request/cance/{id}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\\"reasoncode\\" \\"string\\",\\"clientidentifier\\" \\"string\\"}'", "customlabel" "" }, { "id" "ed wqzeb9nxa2poyy jid", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' '/v1/payments/{id}/payment request/cance/{id}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "dlqf4iwn8gtuo cw3v5u", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"/v1/payments/{id}/payment request/cance/{id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ogl 5ekczjgvj0vqnnlrx", "language" "python", "code" "import requests\nimport json\n\nurl = \\"/v1/payments/{id}/payment request/cance/{id}\\"\n\npayload = json dumps({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "6r4lqav8xm7vyja0pl2fr", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/v1/payments/{id}/payment request/cance/{id}\\")\n\nhttp = net http new(url host, url port);\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n})\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" }, { "id" "jdqut90gb00yiyzwpjcva", "language" "curl", "code" "curl location globoff '/v1/payments/{id}/payment request/cancel/{id}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\\"reasoncode\\" \\"string\\",\\"clientidentifier\\" \\"string\\"}'", "customlabel" "" }, { "id" "aatwfcasoq fqocftdjia", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' '/v1/payments/{id}/payment request/cancel/{id}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "l9eiiuoqguuggusd3svy6", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"/v1/payments/{id}/payment request/cancel/{id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "vkqxvdvzdileppdjpk34w", "language" "python", "code" "import requests\nimport json\n\nurl = \\"/v1/payments/{id}/payment request/cancel/{id}\\"\n\npayload = json dumps({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "3dyn05unvlqna7yudbb8g", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/v1/payments/{id}/payment request/cancel/{id}\\")\n\nhttp = net http new(url host, url port);\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n})\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" }, { "id" "6d1 8hl v0csk5vdnkfsl", "language" "curl", "code" "curl location globoff '/v1/payments/{id}/payment request/cancel/{id}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\\"reasoncode\\" \\"string\\",\\"clientidentifier\\" \\"string\\"}'", "customlabel" "" }, { "id" "w9bhiqv6h7gj92e7mg0ar", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' '/v1/payments/{id}/payment request/cancel/{id}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "wsa6thtdkhdopqzprj a7", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"/v1/payments/{id}/payment request/cancel/{id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "9 b7wkrcvisukuafdhi30", "language" "python", "code" "import requests\nimport json\n\nurl = \\"/v1/payments/{id}/payment request/cancel/{id}\\"\n\npayload = json dumps({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "d5t 3wasn rozzy1uo n", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/v1/payments/{id}/payment request/cancel/{id}\\")\n\nhttp = net http new(url host, url port);\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"reasoncode\\" \\"string\\",\n \\"clientidentifier\\" \\"string\\"\n})\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "oxrdniu1 dt00zxdeyi99" }, "results" { "languages" \[ { "id" "za7e vgg1euptpxfre3cs", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"9fb39c2f 50da 4012 9cb5 b27a0128870f\\",\n \\"originalpaymentid\\" \\"d41e2e21 4216 4fda be55 b27a0073d6c8\\",\n \\"referenceid\\" \\"r035o93z28u23\\",\n \\"accountnumber\\" \\"2532733231\\",\n \\"clientidentifier\\" \\"string\\",\n \\"amount\\" 999,\n \\"direction\\" \\"outbound\\",\n \\"status\\" \\"created\\",\n \\"paymenttype\\" \\"requestforpaymentcancellation\\",\n \\"source\\" \\"opsportal\\",\n \\"transactionaccountcontext\\" \\"notsubmitted\\",\n \\"debtor\\" {\n \\"routingnumber\\" \\"234567891\\",\n \\"accountnumber\\" \\"100000001\\",\n \\"name\\" \\"counter party\\",\n \\"addressstreetname\\" \\"123linwood aveasdfjal\\",\n \\"addresscity\\" \\"pine brook\\",\n \\"addressstate\\" \\"nj\\",\n \\"addresspostalcode\\" \\"07024\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"creditor\\" {\n \\"routingnumber\\" \\"021214891\\",\n \\"accountnumber\\" \\"2532733231\\",\n \\"name\\" \\"x d\\"\n },\n \\"network\\" {\n \\"businessmessageid\\" \\"b20250204021214273t1bfov55625377447\\",\n \\"messageid\\" \\"m20250204021214273t1brwn20370101112\\",\n \\"createdat\\" \\"2025 02 04t12 59 37 4333356 05 00\\",\n \\"numberoftransactions\\" 0,\n \\"interbanksettlementamount\\" 0,\n \\"fromparticipantid\\" \\"021214273t1\\",\n \\"toparticipantid\\" \\"990000001s1\\",\n \\"headercreationdate\\" \\"2025 02 04t12 59 37 4333356 05 00\\",\n \\"messagecreationdatetime\\" \\"2025 02 04t12 59 37 4333356 05 00\\"\n },\n \\"assignment\\" {\n \\"id\\" \\"m20250204021214273t1brwn20370101112\\",\n \\"creationdatetime\\" \\"2025 02 04t12 59 37 4333356 05 00\\",\n \\"assignerroutingnumber\\" \\"021214891\\",\n \\"assigneeroutingnumber\\" \\"234567891\\"\n },\n \\"originalmsgrefs\\" {\n \\"messageid\\" \\"m20250204021214273t1bfrp38196091917\\",\n \\"messagenameid\\" \\"pain 013 001 07\\",\n \\"creationdatetime\\" \\"2025 02 04t02 01 46 863 05 00\\",\n \\"instructionid\\" \\"20250204021214273t1b583277205881612\\",\n \\"endtoendid\\" \\"9d7b440fc018462f980db27a0073d6c8\\",\n \\"transactionid\\" \\"20250204021214273t1b583277205881612\\",\n \\"clearingsystemref\\" \\"001\\",\n \\"interbanksettlementamount\\" 999,\n \\"currency\\" \\"usd\\",\n \\"interbanksettlementdate\\" \\"2025 02 04\\"\n },\n \\"case\\" {\n \\"id\\" \\"m20250204021214273t1brwn20370101112\\",\n \\"creatorroutingnumber\\" \\"021214891\\",\n \\"originatorname\\" \\"x d\\",\n \\"originatorroutingnumber\\" \\"021214891\\"\n },\n \\"transactioninfo\\" {\n \\"reasoncode\\" \\"ac03\\"\n },\n \\"currency\\" \\"usd\\",\n \\"purpose\\" \\"entered by #64e4b65b20cf2dd52a39b2cd# cancel request for payment\\",\n \\"wasrefunded\\" false,\n \\"waspaid\\" false,\n \\"createdat\\" \\"2025 02 04t12 59 37 4333356 05 00\\",\n \\"canceledat\\" \\"2025 02 04t12 59 37 4333356 05 00\\",\n \\"productid\\" \\"a2eac905 3f73 4cad aebd b06e00d945b7\\",\n \\"partnerid\\" \\"f176a518 381f 487b 9507 b06e00d8cd18\\",\n \\"lastmodifiedat\\" \\"2025 02 04t12 59 37 5270995 05 00\\",\n \\"sendattemptcount\\" 0,\n \\"discounts\\" \[],\n \\"awaitingresponse\\" false,\n \\"referencedpaymentid\\" \\"d41e2e21 4216 4fda be55 b27a0073d6c8\\",\n \\"networkplatform\\" \\"tch\\"\n}" } ], "selectedlanguageid" "za7e vgg1euptpxfre3cs" }, "request" { "pathparameters" \[ { "name" "id", "kind" "required", "type" "string", "description" "the payment id this first appears in the initial response to canceling a payment request this id is in guid format ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "reasoncode", "kind" "required", "type" "string", "description" "reason code for payment request cancellation specifies the justification for the cancellation please refer to the request and response codes page for more details ", "children" \[] }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "a unique identifier assigned to the payment call or cos record this value reflects the identifier provided in the original request and helps ensure idempotency ", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the payment id this first appears in the initial response to canceling a payment request this id is in guid format " }, { "name" "originalpaymentid", "kind" "optional", "type" "string", "description" "the payment id of the original payment request this id is in guid format", "children" \[] }, { "name" "referenceid", "kind" "optional", "type" "string", "description" "this unique cross river reference id starts with the first letter of the payment rail for instant payments, the id begins with r to reflect the rtp api module ", "children" \[] }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account initiating the payment request", "children" \[] }, { "name" "clientidentifier", "kind" "optional", "type" "string", "description" "a unique identifier assigned to the payment call or cos record this value reflects the identifier provided in the original request and helps ensure idempotency ", "children" \[] }, { "name" "amount", "kind" "optional", "type" "integer", "description" "dollar amount of payment request in positive integral cents for example, write $1 00 as 100 ", "children" \[] }, { "name" "operatorcoretransactionid", "kind" "optional", "type" "string", "description" "the instant payments related cross river system transaction id", "children" \[] }, { "name" "authorizationtransactionid", "kind" "optional", "type" "string", "description" "the id of an authorization transaction created when cross river receives an inbound credit transfer that refunds a previously sent outbound transfer this authorization confirms that cross river can post the transaction to the creditor’s (receiver’s) cos account (e g , no restrictions or account closures) and allows cross river to notify the real time payment network of acceptance ", "children" \[] }, { "name" "memopostid", "kind" "optional", "type" "string", "description" "the id of the memo post", "children" \[] }, { "name" "memopostremovedat", "kind" "optional", "type" "string", "description" "the date and time of the memo post have been removed", "children" \[] }, { "name" "direction", "kind" "optional", "type" "string", "description" "outbound for an outbound payment request cancellation", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "transaction status \n\n created\n pending\n processing\n completed\n rejected\n canceled\n hold\n timedout\n finalizing\n failed\n researchrequired\n expired\n authorized", "children" \[] }, { "name" "paymenttype", "kind" "optional", "type" "string", "description" "type of payment indicating how the transaction is funded \n\n requestforpaymentcancellation\n", "children" \[] }, { "name" "source", "kind" "optional", "type" "string", "description" "the source of the activity \n api", "children" \[] }, { "name" "transactionaccountcontext", "kind" "optional", "type" "string", "description" "transaction account context \n\n notsubmitted\n pending\n processing\n complete\n reversal\n memopost\n timedout\n canceled\n rejected\n authonly\n notset", "children" \[] }, { "name" "debtor", "kind" "optional", "type" "object", "description" "debtor business/individual information the recipient of the rfp who will initiate the credit transfer upon authorization depending on the configuration, this information may be populated automatically ", "children" \[ { "name" "routingnumber", "kind" "optional", "type" "string", "description" "9 digit routing number of the sending financial institution" }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number in cr, depending on the account type, the number of digits will vary the first digit indicates the kind of account " }, { "name" "name", "kind" "optional", "type" "string", "description" "name of entity" }, { "name" "birthcity", "kind" "optional", "type" "string", "description" "debtor birth city" }, { "name" "birthcountry", "kind" "optional", "type" "string", "description" "debtor birth country 2 letter country code " }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "debtor birth date formatted as yyyy mm dd " }, { "name" "orglegalentityid", "kind" "optional", "type" "string", "description" "a unique global identifier for legal entities that are not consumers but are participating in financial transactions" }, { "name" "proxyid", "kind" "optional", "type" "string", "description" "identification used to represent the account under a different name or alias, such as a mobile number or email address" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "10 digit phone number" }, { "name" "addressstreetname", "kind" "optional", "type" "string", "description" "street address name information" }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number" }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name" }, { "name" "addressstate", "kind" "optional", "type" "string", "description" "2 letter code for the state" }, { "name" "addresspostalcode", "kind" "optional", "type" "string", "description" "postal or zip code" }, { "name" "addresscountry", "kind" "optional", "type" "string", "description" "2 letter country code" } ] }, { "name" "ultimatedebtor", "kind" "optional", "type" "object", "description" "ultimate debtor business/individual information the final party responsible for initiating the credit transfer upon authorization this information may be populated automatically based on the configuration ", "children" \[ { "name" "name", "kind" "optional", "type" "string", "description" "name of entity" }, { "name" "privateid", "kind" "optional", "type" "string", "description" "unique and unambiguous identification of a person, for example, a passport number" }, { "name" "orglegalentityid", "kind" "optional", "type" "string", "description" "a unique global identifier for legal entities that are not consumers but are participating in financial transactions" }, { "name" "addressstreetname", "kind" "optional", "type" "string", "description" "street address name information" }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number" }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name" }, { "name" "addressstate", "kind" "optional", "type" "string", "description" "2 letter code for the state" }, { "name" "addresspostalcode", "kind" "optional", "type" "string", "description" "postal or zip code" }, { "name" "addresscountry", "kind" "optional", "type" "string", "description" "2 letter country code" } ] }, { "name" "creditor", "kind" "optional", "type" "object", "description" "creditor business/individual information the recipient of the payment, typically the party at crb initiating the rfp depending on the configuration, this information may be populated automatically ", "children" \[ { "name" "routingnumber", "kind" "optional", "type" "string", "description" "9 digit routing number of the receiving financial institution" }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number in cr, depending on the account type, the number of digits will vary the first digit indicates the kind of account " }, { "name" "name", "kind" "optional", "type" "string", "description" "name of entity" }, { "name" "birthcity", "kind" "optional", "type" "string", "description" "creditor birth city" }, { "name" "birthcountry", "kind" "optional", "type" "string", "description" "creditor birth country 2 letter country code " }, { "name" "birthdate", "kind" "optional", "type" "string", "description" "creditor birth date formatted as yyyy mm dd " }, { "name" "orglegalentityid", "kind" "optional", "type" "string", "description" "a unique global identifier for legal entities that are not consumers but are participating in financial transactions" }, { "name" "proxyid", "kind" "optional", "type" "string", "description" "identification used to represent the account under a different name or alias, such as a mobile number or email address" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "10 digit phone number" }, { "name" "addressstreetname", "kind" "optional", "type" "string", "description" "street address name information" }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number" }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name" }, { "name" "addressstate", "kind" "optional", "type" "string", "description" "2 letter code for the state" }, { "name" "addresspostalcode", "kind" "optional", "type" "string", "description" "postal or zip code" }, { "name" "addresscountry", "kind" "optional", "type" "string", "description" "2 letter country code" } ] }, { "name" "ultimatecreditor", "kind" "optional", "type" "object", "description" "ultimate creditor business/individual information the final recipient of the payment depending on the configuration, this information may be populated automatically ", "children" \[ { "name" "name", "kind" "optional", "type" "string", "description" "name of entity" }, { "name" "privateid", "kind" "optional", "type" "string", "description" "unique and unambiguous identification of a person, for example, a passport number" }, { "name" "orglegalentityid", "kind" "optional", "type" "string", "description" "a unique global identifier for legal entities that are not consumers but are participating in financial transactions" }, { "name" "addressstreetnameadd", "kind" "optional", "type" "string", "description" "street address name information" }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information" }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number" }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name" }, { "name" "addressstate", "kind" "optional", "type" "string", "description" "2 letter code for the state" }, { "name" "addresspostalcode", "kind" "optional", "type" "string", "description" "postal or zip code" }, { "name" "addresscountry", "kind" "optional", "type" "string", "description" "2 letter country code" } ] }, { "name" "network", "kind" "optional", "type" "object", "description" "network information", "children" \[ { "name" "businessmessageid", "kind" "optional", "type" "string", "description" "unique identifier of the business message" }, { "name" "messageid", "kind" "optional", "type" "string", "description" "unique identifier of the message" }, { "name" "createdat", "kind" "optional", "type" "string", "description" "indicates when the payment request cancellation message was created, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "numberoftransactions", "kind" "optional", "type" "integer", "description" "the total count of transactions" }, { "name" "interbanksettlementamount", "kind" "optional", "type" "integer", "description" "the total amount the debtor fi must pay to the creditor fi once the creditor fi accepts the payment instructed by the credit transfer message" }, { "name" "fromparticipantid", "kind" "optional", "type" "string", "description" "the unique identifier of the participant sending the message on the instant payment network platform" }, { "name" "toparticipantid", "kind" "optional", "type" "string", "description" "the unique identifier of the participant receiving the message on the instant payment network platform" }, { "name" "tobranchid", "kind" "optional", "type" "string", "description" "identifies the specific branch of a financial institution that received the message, used exclusively for routing purposes in instant payments" }, { "name" "instructingroutingnumber", "kind" "optional", "type" "string", "description" "sending bank routing number" }, { "name" "instructedroutingnumber", "kind" "optional", "type" "string", "description" "receiving bank routing number" }, { "name" "headercreationdate", "kind" "optional", "type" "string", "description" "internal to cr" }, { "name" "messagecreationdatetime", "kind" "optional", "type" "string", "description" "the date and time when the payment request cancellation message was created, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]" } ] }, { "name" "assignment", "kind" "optional", "type" "object", "description" "assignment details provided when an investigation is initiated the assigner is the sender of the confirmation, and the assignee is the receiver ", "children" \[ { "name" "id", "kind" "optional", "type" "string", "description" "a 35 character identifier representing the assignment of an investigation case from the assigner to the assignee " }, { "name" "creationdatetime", "kind" "optional", "type" "string", "description" "the date and time the item was created, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] " }, { "name" "assignerroutingnumber", "kind" "optional", "type" "string", "description" "the routing number of the message sender, who is the assigner of the case" }, { "name" "assigneeroutingnumber", "kind" "optional", "type" "string", "description" "the routing number of the message receiver, who is the assignee of the case" } ] }, { "name" "originalmsgrefs", "kind" "optional", "type" "object", "description" "reference details from the original message associated with the transaction", "children" \[ { "name" "messageid", "kind" "optional", "type" "string", "description" "message id" }, { "name" "messagenameid", "kind" "optional", "type" "string", "description" "message name id" }, { "name" "creationdatetime", "kind" "optional", "type" "string", "description" "the date and time the original message was created, formatted as ddthh\ mm\ ss\[ mmm]" }, { "name" "instructionid", "kind" "optional", "type" "string", "description" "the unique id of the payment request cancellation assigned by the instructing agent while it remains in the rtp system " }, { "name" "endtoendid", "kind" "optional", "type" "string", "description" "the unique id assigned by the initiating party to identify the transaction" }, { "name" "transactionid", "kind" "optional", "type" "string", "description" "a unique guid format string that distinctly identifies the transaction and remains unchanged throughout the entire interbank chain" }, { "name" "clearingsystemref", "kind" "optional", "type" "string", "description" "identifies the reconciliation window during which the credit transfer was settled" }, { "name" "interbanksettlementamount", "kind" "optional", "type" "integer", "description" "the total amount the debtor fi is required to pay to the creditor fi once the creditor fi accepts the payment instructed by the credit transfer message " }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency of the payment" }, { "name" "interbanksettlementdate", "kind" "optional", "type" "string", "description" "the date linked to the reconciliation windowclosed (clearing system reference) this value is used in instant payments, alongside the clearing system reference, to allocate a credit transfer to a specific reconciliation window " } ] }, { "name" "case", "kind" "optional", "type" "object", "description" "case object information", "children" \[ { "name" "id", "kind" "optional", "type" "string", "description" "a unique identifier for the investigation case related to a request for return of funds" }, { "name" "creatorroutingnumber", "kind" "optional", "type" "string", "description" "the routing number of the entity that created the investigation case" }, { "name" "originatorname", "kind" "optional", "type" "string", "description" "the entity that initiated the request for return of funds" }, { "name" "originatorroutingnumber", "kind" "optional", "type" "string", "description" "the routing number of the financial institution (fi) that initiated the request for return of funds" } ] }, { "name" "transactioninfo", "kind" "optional", "type" "object", "description" "information about the transaction", "children" \[ { "name" "status", "kind" "optional", "type" "string", "description" "the current status of a single payment instruction within the transaction process" }, { "name" "reasoncode", "kind" "optional", "type" "string", "description" "a code that specifies the reason a transaction did not complete refer to the list of reason codes for details " }, { "name" "additionalinfo", "kind" "optional", "type" "string", "description" "provides supplementary details regarding the status report" }, { "name" "reasonproprietary", "kind" "optional", "type" "string", "description" "indicates the local instrument by using a proprietary code" } ] }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency of the payment", "children" \[] }, { "name" "purpose", "kind" "optional", "type" "string", "description" "request the rdfi does not see this field ", "children" \[] }, { "name" "wasrefunded", "kind" "optional", "type" "boolean", "description" "indicates whether the payment was refunded true if refunded, otherwise false ", "children" \[] }, { "name" "waspaid", "kind" "optional", "type" "boolean", "description" "indicates whether the payment was received true if received, otherwise false ", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer was created, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "canceledat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer was canceled, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] if the transfer was not canceled, this field will be null ", "children" \[] }, { "name" "productid", "kind" "optional", "type" "string", "description" "the guid representing the id of your specific product type associated with the account this is provided by cr and identifies the cr account involved in the transfer ", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your unique id within the cr system, provided in guid format", "children" \[] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "an internal cr value indicating the date and time the database entry was last modified, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "sendattemptcount", "kind" "optional", "type" "integer", "description" "the total count of attempts to send the payment request cancellation", "children" \[] }, { "name" "discounts", "kind" "optional", "type" "object", "description" "discounts array specifies applicable discounts for this request", "children" \[ { "name" "type", "kind" "optional", "type" "string", "description" "the type of discount applied \npossible values include \n dsct a standard discount applied to the payment\n full a full payment discount (for example early payment incentive) " }, { "name" "amount", "kind" "optional", "type" "integer", "description" "amount of discount in positive integral cents for example, write $1 00 as 100 " }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency of the discount for example usd " } ] }, { "name" "awaitingresponse", "kind" "optional", "type" "boolean", "description" "indicates whether a message response is pending true if waiting, otherwise false \n", "children" \[] }, { "name" "referencepaymentid", "kind" "optional", "type" "string", "description" "the cr payment id used to reference cases where a payment request cancellation is associated with a previous payment request this id is in guid format ", "children" \[] }, { "name" "queuedpaymentexpiresat", "kind" "optional", "type" "string", "description" "date and time that a queued payment will expire (payment canceled) if the receiving fi is offline, in this format yyyy mm ddthh\ mm\ ss\[ mmm] not sent to tch/fed ", "children" \[] }, { "name" "limitseligibleon", "kind" "optional", "type" "string", "description" "the validation performed when originating a payment to ensure it falls within the partner's daily limit this is an internal cross river field, with the date and time formatted as yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "networkplatform", "kind" "optional", "type" "string", "description" "the payment network platform used to process the payment possible values are tch (for rtp via the clearing house) ", "children" \[] }, { "name" "queuedpaymentexpiresafter", "kind" "optional", "type" "integer", "description" "the time interval (in seconds) after which a queued payment will expire if the receiving fi remains offline this is not sent to tch or fed \n\nif both queuedpaymentexpiresat and this attribute are provided, this attribute will take precedence \[preferred by cross river]", "children" \[] } ], "autogeneratedanchorslug" "endpoint rtpv1paymentsidpayment requestcancel", "legacyhash" "tegutzw0i7 fkozlmntxe" } refer to docid\ vlhwgfsbypp5occfptwaj for a complete list of reason code values