Credit transfer

relevant webhooks for this endpoint be sure you have docid\ bn5xtgkjogbe ctwomcbs for these webhooks docid\ ffgq2ohyebwpzn2old6mc docid\ ffgq2ohyebwpzn2old6mc rtp payment researchrequired rtp payment queued api reference post a payment by id initiates an instant payment credit transfer enables real time fund transfers from your account to the recipient's account transfers can originate from master account deposit account (dda) associated subledger { "name" "endpoint /rtp/v1/payments", "method" "post", "url" "https //sandbox crbcos com/rtp/v1/payments", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "tiu4cyzv2obskcr5taq d", "language" "curl", "code" "curl l 'https //sandbox crbcos com/rtp/v1/payments' ^\n d '{\n \\"accountnumber\\" \\"2955057589\\",\n \\"amount\\" 10000,\n \\"creditor\\" {\n \\"routingnumber\\" \\"011000138\\", \n \\"accountnumber\\" \\"456789000\\",\n \\"name\\" \\"richard robert\\",\n \\"addressstreetname\\" \\"speedway blvd\\",\n \\"addressbuildingnumber\\" \\"3366\\",\n \\"addresscity\\" \\"talladega\\",\n \\"addressstate\\" \\"al\\",\n \\"addresspostalcode\\" \\"35096\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"purpose\\" \\"sponsor donation\\",\n \\"clientidentifier\\" \\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\"\n}'", "customlabel" "" }, { "id" "e7 mgvgr9rfogbp377bsi", "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' '/rtp/v1/payments',\n 'headers' {\n 'idempotency key' '3e4ac46c fa9e 4654 80b8 83f971622dfd'\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 \\\\\\"amount\\\\\\" 10000,\\\r\\\n \\\\\\"creditor\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"011000138\\\\\\", \\\n \\\\\\"accountnumber\\\\\\" \\\\\\"456789000\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"richard robert\\\\\\",\\\r\\\n \\\\\\"addressstreetname\\\\\\" \\\\\\"speedway blvd\\\\\\",\\\r\\\n \\\\\\"addressbuildingnumber\\\\\\" \\\\\\"3366\\\\\\",\\\r\\\n \\\\\\"addresscity\\\\\\" \\\\\\"talladega\\\\\\",\\\r\\\n \\\\\\"addressstate\\\\\\" \\\\\\"al\\\\\\",\\\r\\\n \\\\\\"addresspostalcode\\\\\\" \\\\\\"35096\\\\\\",\\\r\\\n \\\\\\"addresscountry\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"purpose\\\\\\" \\\\\\"sponsor donation\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\\\\\"\\\r\\\n}\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "wglk1we4hz2bo86qu5wum", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/rtp/v1/payments\\"\n\npayload = \\"{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2955057589\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 10000,\\\r\\\n \\\\\\"creditor\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"011000138\\\\\\", \\\n \\\\\\"accountnumber\\\\\\" \\\\\\"456789000\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"richard robert\\\\\\",\\\r\\\n \\\\\\"addressstreetname\\\\\\" \\\\\\"speedway blvd\\\\\\",\\\r\\\n \\\\\\"addressbuildingnumber\\\\\\" \\\\\\"3366\\\\\\",\\\r\\\n \\\\\\"addresscity\\\\\\" \\\\\\"talladega\\\\\\",\\\r\\\n \\\\\\"addressstate\\\\\\" \\\\\\"al\\\\\\",\\\r\\\n \\\\\\"addresspostalcode\\\\\\" \\\\\\"35096\\\\\\",\\\r\\\n \\\\\\"addresscountry\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"purpose\\\\\\" \\\\\\"sponsor donation\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\\\\\"\\\r\\\n}\\"\nheaders = {\n 'idempotency key' '3e4ac46c fa9e 4654 80b8 83f971622dfd'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "x4adogum w4tsfrsqksro", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/rtp/v1/payments\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"idempotency key\\"] = \\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\"\nrequest body = \\"{\\\r\\\n \\\\\\"accountnumber\\\\\\" \\\\\\"2955057589\\\\\\",\\\r\\\n \\\\\\"amount\\\\\\" 10000,\\\r\\\n \\\\\\"creditor\\\\\\" {\\\r\\\n \\\\\\"routingnumber\\\\\\" \\\\\\"011000138\\\\\\", \\\n \\\\\\"accountnumber\\\\\\" \\\\\\"456789000\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"richard robert\\\\\\",\\\r\\\n \\\\\\"addressstreetname\\\\\\" \\\\\\"speedway blvd\\\\\\",\\\r\\\n \\\\\\"addressbuildingnumber\\\\\\" \\\\\\"3366\\\\\\",\\\r\\\n \\\\\\"addresscity\\\\\\" \\\\\\"talladega\\\\\\",\\\r\\\n \\\\\\"addressstate\\\\\\" \\\\\\"al\\\\\\",\\\r\\\n \\\\\\"addresspostalcode\\\\\\" \\\\\\"35096\\\\\\",\\\r\\\n \\\\\\"addresscountry\\\\\\" \\\\\\"us\\\\\\"\\\r\\\n },\\\r\\\n \\\\\\"purpose\\\\\\" \\\\\\"sponsor donation\\\\\\",\\\r\\\n \\\\\\"clientidentifier\\\\\\" \\\\\\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\\\\\"\\\r\\\n}\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "sggobaclztyqwoy1demwe", "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/rtp/v1/payments\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"accountnumber\\" \\"2955057589\\",`+\\"\n\\"+`\n \\"amount\\" 10000,`+\\"\n\\"+`\n \\"creditor\\" {`+\\"\n\\"+`\n \\"routingnumber\\" \\"011000138\\", \n \\"accountnumber\\" \\"456789000\\",`+\\"\n\\"+`\n \\"name\\" \\"richard robert\\",`+\\"\n\\"+`\n \\"addressstreetname\\" \\"speedway blvd\\",`+\\"\n\\"+`\n \\"addressbuildingnumber\\" \\"3366\\",`+\\"\n\\"+`\n \\"addresscity\\" \\"talladega\\",`+\\"\n\\"+`\n \\"addressstate\\" \\"al\\",`+\\"\n\\"+`\n \\"addresspostalcode\\" \\"35096\\",`+\\"\n\\"+`\n \\"addresscountry\\" \\"us\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n \\"purpose\\" \\"sponsor donation\\",`+\\"\n\\"+`\n \\"clientidentifier\\" \\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\"`+\\"\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 req header add(\\"idempotency key\\", \\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\")\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" "tiu4cyzv2obskcr5taq d" }, "results" { "languages" \[ { "id" "za7e vgg1euptpxfre3cs", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"8177d9d1 e706 49f3 b0a3 b300009ffcf3\\",\n \\"originalpaymentid\\" \\"8177d9d1 e706 49f3 b0a3 b300009ffcf3\\",\n \\"referenceid\\" \\"r169o74976262\\",\n \\"accountnumber\\" \\"2955057589\\",\n \\"clientidentifier\\" \\"3e4ac46c fa9e 4654 80b8 83f971622dfd\\",\n \\"amount\\" 1500,\n \\"direction\\" \\"outbound\\",\n \\"status\\" \\"created\\",\n \\"paymenttype\\" \\"credittransfer\\",\n \\"source\\" \\"api\\",\n \\"transactionaccountcontext\\" \\"notsubmitted\\",\n \\"debtor\\" {\n \\"routingnumber\\" \\"021214891\\",\n \\"accountnumber\\" \\"2955057589\\",\n \\"name\\" \\"dim mak\\",\n \\"addressstreetname\\" \\"400 kelby st\\",\n \\"addresscity\\" \\"fort lee\\",\n \\"addressstate\\" \\"nj\\",\n \\"addresspostalcode\\" \\"07024\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"creditor\\" {\n \\"routingnumber\\" \\"011000138\\",\n \\"accountnumber\\" \\"456789000\\",\n \\"name\\" \\"richard robert\\",\n \\"addressstreetname\\" \\"speedway blvd\\",\n \\"addressbuildingnumber\\" \\"3366\\",\n \\"addresscity\\" \\"talladega\\",\n \\"addressstate\\" \\"al\\",\n \\"addresspostalcode\\" \\"35096\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"network\\" {\n \\"businessmessageid\\" \\"b20250618021214273t1bubt97200579713\\",\n \\"messageid\\" \\"m20250618021214273t1bzzd70574502544\\",\n \\"createdat\\" \\"2025 06 18t05 42 29 9268876 04 00\\",\n \\"numberoftransactions\\" 1,\n \\"interbanksettlementamount\\" 1500,\n \\"currency\\" \\"usd\\",\n \\"interbanksettlementdate\\" \\"2025 06 18\\",\n \\"settlementmethod\\" \\"clrg\\",\n \\"clearingsystemcode\\" \\"tch\\",\n \\"instructionid\\" \\"20250618021214273t1b7od838696205667\\",\n \\"endtoendid\\" \\"eb80f3de5bf84751bdf7b300009ffcf3\\",\n \\"transactionid\\" \\"20250618021214273t1b7od838696205667\\",\n \\"fromparticipantid\\" \\"021214273t1\\",\n \\"toparticipantid\\" \\"990000001s1\\",\n \\"instructingroutingnumber\\" \\"021214891\\",\n \\"instructedroutingnumber\\" \\"011000138\\",\n \\"headercreationdate\\" \\"2025 06 18t05 42 29 9268876 04 00\\",\n \\"messagecreationdatetime\\" \\"2025 06 18t05 42 29 9268876 04 00\\"\n },\n \\"servicelevelcode\\" \\"sdva\\",\n \\"localinstrumentproprietary\\" \\"standard\\",\n \\"categorypurpose\\" \\"consumer\\",\n \\"currency\\" \\"usd\\",\n \\"chargebearer\\" \\"slev\\",\n \\"purpose\\" \\"sponsor donation\\",\n \\"wasrefunded\\" false,\n \\"waspaid\\" false,\n \\"createdat\\" \\"2025 06 18t05 42 29 9268876 04 00\\",\n \\"productid\\" \\"29f3022a ccfc 42eb aa8f b29500f13d00\\",\n \\"partnerid\\" \\"1101a33d fbd9 4b9e b169 b29500f12407\\",\n \\"lastmodifiedat\\" \\"2025 06 18t05 42 29 9268876 04 00\\",\n \\"sendattemptcount\\" 0,\n \\"discounts\\" \[],\n \\"awaitingresponse\\" false,\n \\"limitseligibleon\\" \\"2025 06 18t05 42 29 9268876 04 00\\",\n \\"networkplatform\\" \\"tch\\"\n}" }, { "id" "uzha3puwndymmo ww9a6y", "language" "400", "code" "{\n \\"errors\\" \[\n {\n \\"code\\" 2221,\n \\"message\\" \\"custom originator data not allowed for account\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "za7e vgg1euptpxfre3cs" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "account that funds the payment" }, { "name" "amount", "kind" "required", "type" "integer", "description" "dollar amount of transaction in positive integral cents for example, write $1 00 as 100 ", "children" \[] }, { "name" "debtor", "kind" "optional", "type" "object", "description" "debtor business/individual information depending on the configuration, this might be populated automatically ", "children" \[ { "name" "accountnumber", "kind" "required", "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 140 characters maximum " }, { "name" "birthcity", "kind" "optional", "type" "string", "description" "debtor birth city 35 characters maximum " }, { "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 20 characters maximum " }, { "name" "addressstreetname", "kind" "optional", "type" "string", "description" "street address name information 70 characters maximum " }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information 70 characters maximum " }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number 16 characters maximum " }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name 35 characters maximum " }, { "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", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of entity 140 characters maximum " }, { "name" "privateid", "kind" "optional", "type" "string", "description" "unique and unambiguous identification of a person for example, passport or driving license 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 20 characters maximum " }, { "name" "addressstreetname", "kind" "optional", "type" "string", "description" "street address name information 70 characters maximum " }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information 70 characters maximum " }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number 16 characters maximum " }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name 35 characters maximum " }, { "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" "required", "type" "object", "description" "creditor business/individual information", "children" \[ { "name" "routingnumber", "kind" "required", "type" "string", "description" "9 digit routing number of the receiving financial institution" }, { "name" "accountnumber", "kind" "required", "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" "required", "type" "string", "description" "name of entity 140 characters maximum " }, { "name" "birthcity", "kind" "optional", "type" "string", "description" "creditor birth city 35 characters maximum " }, { "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 20 characters maximum " }, { "name" "addressstreetname", "kind" "optional", "type" "string", "description" "street address name information 70 characters maximum " }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information 70 characters maximum " }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number 16 characters maximum " }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name 35 characters maximum " }, { "name" "adressstate", "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" } ], "schema" \[ { "name" "routingnumber", "kind" "required", "type" "string", "description" "9 digit routing number of the receiving financial institution" }, { "name" "accountnumber", "kind" "required", "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" "required", "type" "string", "description" "name of entity 140 characters maximum " }, { "name" "birthcity", "kind" "optional", "type" "string", "description" "creditor birth city 35 characters maximum " }, { "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 20 characters maximum " }, { "name" "addressstreetname", "kind" "optional", "type" "string", "description" "street address name information 70 characters maximum " }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information 70 characters maximum " }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number 16 characters maximum " }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name 35 characters maximum " }, { "name" "adressstate", "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", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "name of entity 140 characters maximum " }, { "name" "privateid", "kind" "optional", "type" "string", "description" "unique and unambiguous identification of a person for example, passport or driving license 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 20 characters maximum " }, { "name" "addressstreetnameadd", "kind" "optional", "type" "string", "description" "street address name information 70 characters maximum " }, { "name" "addressline", "kind" "optional", "type" "string", "description" "additional address information 70 characters maximum " }, { "name" "addressbuildingnumber", "kind" "optional", "type" "string", "description" "street address building number 16 characters maximum " }, { "name" "addresscity", "kind" "optional", "type" "string", "description" "city full name 35 characters maximum " }, { "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" "purpose", "kind" "optional", "type" "string", "description" "internal cr field used to include a short description of the purpose of the payment the rdfi does not see this field 50 characters maximum ", "children" \[] }, { "name" "remittancedata", "kind" "optional", "type" "string", "description" "a description of the payment, meaning, the remittance advice use this field for any remittance information that doesn't have its own field 140 characters maximum ", "children" \[] }, { "name" "remittancelocation", "kind" "optional", "type" "object", "description" "remittance location information", "children" \[ { "name" "method", "kind" "required", "type" "string", "description" "method used to deliver the remittance advice information email or urid " }, { "name" "eaddress", "kind" "required", "type" "string", "description" "the electronic address where the agent should send the remittance information this is only populated if the method value is email " } ] }, { "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 50 characters maximum ", "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), fednow, or crnow ", "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" "queuedpaymentexpiresafterinseconds", "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]", "" "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]" } ], "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 the originate a payment request this id is in guid format " }, { "name" "originalpaymentid", "kind" "optional", "type" "string", "description" "original payment id (only relevant if a payment didn't go through for some reason) ", "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 that funds the payment", "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 transaction in positive integral cents for example, write $1 00 as 100 ", "children" \[] }, { "name" "operatorcoretransactionid", "kind" "optional", "type" "string", "description" "the instant payments related cr 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 the memo post was removed\n", "children" \[] }, { "name" "direction", "kind" "optional", "type" "string", "description" "outbound for an outbound credit transfer or inbound for an inbound credit transfer", "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\n queued", "children" \[] }, { "name" "paymenttype", "kind" "optional", "type" "string", "description" "type of payment indicating how the transaction is funded \n\n credittransfer\n systemtimeout\n returnrequest\n returnresponse\n remittanceadvice\n requestforinformation\n paymentack\n requestforpayment\n requestforpaymentresponse\n requestforinformationresponse\n requestforpaymentcancellation\n paymentreturn\n paymentstatusrequest\n unknown\n", "children" \[] }, { "name" "source", "kind" "optional", "type" "string", "description" "the source of the activity \n\n phone\n fax\n email\n clearinghouse\n api\n rtpsystemtimeout\n opsportal\n partnerportal\n returnoffunds\n autoresend\n fednow\n crnow", "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" "rtptransactionsstatus", "kind" "optional", "type" "string", "description" "the payment status set by the receiving institution, applicable to credit transfers \n\nthis value is only present for outbound payments see available values here ", "children" \[] }, { "name" "debtor", "kind" "optional", "type" "object", "description" "debtor business/individual information", "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", "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", "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 ", "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" "messagedefid", "kind" "optional", "type" "string", "description" "contains the iso 20022 message identifier specifying the business message" }, { "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 pacs 008 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" "currency", "kind" "optional", "type" "string", "description" "currency of the payment" }, { "name" "interbanksettlementdate", "kind" "optional", "type" "string", "description" "the date linked to the reconciliation window, used in rtp alongside the clearing system reference to allocate a credit transfer to a specific reconciliation window" }, { "name" "settlementmethod", "kind" "optional", "type" "string", "description" "the method used to settle an individual credit transfer processed through rtp " }, { "name" "clearingsystemcode", "kind" "optional", "type" "string", "description" "the code used to specify the clearing system used to settle the credit transfer for rtp the clearing system code is tch " }, { "name" "instructionid", "kind" "optional", "type" "string", "description" "the unique id assigned by the instructing agent for the credit transfer while it remains active within the rtp system \n\nthis id serves as the unique identifier for the credit transfer within the instant payments network \n" }, { "name" "endtoendid", "kind" "optional", "type" "string", "description" "the unique id assigned by the initiating party to identify and track the transaction" }, { "name" "transactionid", "kind" "optional", "type" "string", "description" "a unique string in guid format that clearly identifies the transaction this id passes unchanged the whole interbank chain \n\nthis id serves as the unique identifier for the credit transfer within the instant payments network " }, { "name" "clearingsystemref", "kind" "optional", "type" "string", "description" "identifies the reconciliation window in which the credit transfer was settled" }, { "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" "frombranchid", "kind" "optional", "type" "string", "description" "identifies the specific branch of a financial institution that sent the message, used exclusively for routing purposes in instant payments" }, { "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" "copyduplicate", "kind" "optional", "type" "string", "description" "used by financial institutions when resending a message with an unknown outcome from the original request this flag helps tch prevent duplicate message processing " }, { "name" "headercreationdate", "kind" "optional", "type" "string", "description" "internal to cr" }, { "name" "messagecreationdatetime", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer message was created, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "uetr", "kind" "optional", "type" "string", "description" "a unique end to end transaction reference (uetr) is a string of 36 unique characters featured in all payment instruction messages carried over swift " } ] }, { "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" "canceltransaction", "kind" "optional", "type" "object", "description" "cancel transaction information", "children" \[ { "name" "cancelstatusid", "kind" "optional", "type" "string", "description" "the unique identifier issued by tch for a canceled request for the return of funds" }, { "name" "resolvedinterbankamount", "kind" "optional", "type" "string", "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 (pacs 008) message " }, { "name" "resolvedinterbankdate", "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" "chargesamount", "kind" "optional", "type" "integer", "description" "details regarding charges that are the responsibility of the charge bearer(s) in relation to the credit transfer" }, { "name" "chargesroutingnumber", "kind" "optional", "type" "string", "description" "the routing number of the party responsible for covering any charges related to the credit transfer" }, { "name" "clearingchannel", "kind" "optional", "type" "string", "description" "the method or channel used to process the payment instruction" } ] }, { "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 credit transfer 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" "paymentinfoid", "kind" "optional", "type" "string", "description" "payment information id" }, { "name" "uetr", "kind" "optional", "type" "string", "description" "a unique end to end transaction reference (commonly known as a uetr) is a string of 36 unique characters featured in all payment instruction messages carried over swift " } ] }, { "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" "remittanceadvice", "kind" "optional", "type" "object", "description" "remittance advice information", "children" \[ { "name" "remittanceidentification", "kind" "optional", "type" "string", "description" "\na unique identifier assigned by the initiating party to clearly distinguish the remittance information sent separately from the payment instruction, such as a remittance advice" }, { "name" "originstructionid", "kind" "optional", "type" "string", "description" "the original unique id of the credit transfer, assigned by the instructing agent while it remains in the rtp system" }, { "name" "origendtoendid", "kind" "optional", "type" "string", "description" "the original unique id set by the initiating party to identify the transaction, referring to a previous payment message" }, { "name" "origtransactionid", "kind" "optional", "type" "string", "description" "a unique guid format string that clearly identifies the transaction, referring to a previous payment message this id remains unchanged throughout the entire interbank chain " }, { "name" "origpaymentinfoid", "kind" "optional", "type" "string", "description" "a unique identifier assigned by the original sending party to clearly distinguish the original payment information group" }, { "name" "originstructedamount", "kind" "optional", "type" "integer", "description" "the amount of money specified in the original transaction to be transferred between the debtor and creditor, before any charges are deducted, expressed in the currency requested by the original initiating party" }, { "name" "originstructedamountcurrency", "kind" "optional", "type" "string", "description" "currency of the original transaction" } ] }, { "name" "reportedstatus", "kind" "optional", "type" "object", "description" "reported status information", "children" \[ { "name" "messagestatusreportid", "kind" "optional", "type" "string", "description" "message status report identifier this is in guid format " }, { "name" "accepteddatetime", "kind" "optional", "type" "string", "description" "the point in time when the account servicing agent says that all the needed information has been received, such as the payment order itself, the authorization, and confirmation that there are enough funds in the account, in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "transactionstatus", "kind" "optional", "type" "string", "description" "transaction status of a single payment instruction" }, { "name" "reasoncode", "kind" "optional", "type" "string", "description" "a code specifying the reason a transaction did not complete refer to the list of reason codes for more details " }, { "name" "additionalinfo", "kind" "optional", "type" "string", "description" "provides supplementary details regarding the status report" }, { "name" "reasonproprietary", "kind" "optional", "type" "string", "description" "specifies the local instrument using a proprietary code" } ] }, { "name" "confirmedstatus", "kind" "optional", "type" "object", "description" "confirmed status information", "children" \[ { "name" "messagestatusreportid", "kind" "optional", "type" "string", "description" "the unique identifier for the message status report, provided in guid format" }, { "name" "accepteddatetime", "kind" "optional", "type" "string", "description" "the point in time when the account servicing agent confirms receipt of all necessary information, including the payment order, authorization, and sufficient funds in the account the date and time are formatted as yyyy mm ddthh\ mm\ ss\[ mmm] " }, { "name" "transactionstatus", "kind" "optional", "type" "string", "description" "the current status of an individual payment instruction within the transaction process" }, { "name" "reasoncode", "kind" "optional", "type" "string", "description" "a code specifying the reason a transaction did not complete refer to the list of reason codes for more details " }, { "name" "additionalinfo", "kind" "optional", "type" "string", "description" "provides supplementary details regarding the status report" }, { "name" "reasonproprietary", "kind" "optional", "type" "string", "description" "specifies the local instrument using a proprietary code" } ] }, { "name" "alternaterefundraildetail", "kind" "optional", "type" "object", "description" "details of a refunded payment", "children" \[ { "name" "rail", "kind" "optional", "type" "string", "description" "the payment rail used to process the refund \n\nach\nwires" }, { "name" "paymentid", "kind" "optional", "type" "string", "description" "the guid format payment id of the original transaction" } ] }, { "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" "servicelevelcode", "kind" "optional", "type" "string", "description" "indicates a pre arranged service or service level agreed upon between the parties", "children" \[] }, { "name" "localinstrumentpropriety", "kind" "optional", "type" "string", "description" "specifies whether the debtor is a business or consumer customer of the debtor fi this element also indicates if the debtor is a domestic customer of the debtor fi or a customer of a foreign branch or affiliate ", "children" \[] }, { "name" "categorypurpose", "kind" "optional", "type" "string", "description" "details from the initiating party regarding payment processing, based on predefined categories certain values may initiate special processing by various parties involved in the payment chain ", "children" \[] }, { "name" "initiatingpartyname", "kind" "optional", "type" "string", "description" "name of initiating party/entity", "children" \[] }, { "name" "currency", "kind" "optional", "type" "string", "description" "currency of the payment", "children" \[] }, { "name" "chargebearer", "kind" "optional", "type" "string", "description" "indicates the party (or parties) responsible for bearing the charges related to processing the credit transfer", "children" \[] }, { "name" "remittanceidentification", "kind" "optional", "type" "string", "description" "a unique identifier assigned by the initiating party to clearly distinguish the remittance information sent separately from the payment instruction, such as a remittance advice", "children" \[] }, { "name" "remittancedata", "kind" "optional", "type" "string", "description" "a description of the payment, serving as the remittance advice this field is used for any remittance information that does not have a designated field ", "children" \[] }, { "name" "remittancereferreddocnumber", "kind" "optional", "type" "string", "description" "when a credit transfer is used to return funds from a previously completed credit transfer, the original credit transfer's identification will be included in these fields for bill pay use cases, this may represent the end customer’s account number within the biller’s system or an invoice number ", "children" \[] }, { "name" "remittancereferredrelateddate", "kind" "optional", "type" "string", "description" "the date linked to the document identified by the remittancereferreddocnumber, formatted as yyyy mm dd ", "children" \[] }, { "name" "paymentinfoid", "kind" "optional", "type" "string", "description" "payment information id", "children" \[] }, { "name" "reqexecutiondate", "kind" "optional", "type" "object", "description" "requested execution date information", "children" \[ { "name" "date", "kind" "optional", "type" "string", "description" "the requested date and time of the payment, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "datetype", "kind" "optional", "type" "string", "description" "the date type" } ] }, { "name" "expirydate", "kind" "optional", "type" "object", "description" "expiry date information", "children" \[ { "name" "date", "kind" "optional", "type" "string", "description" "the expiry date and time of the payment, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]" }, { "name" "datetype", "kind" "optional", "type" "string", "description" "the date type" } ] }, { "name" "paymentconditions", "kind" "optional", "type" "object", "description" "payment conditions information", "children" \[ { "name" "guaranteedpayrequest", "kind" "optional", "type" "boolean", "description" "indicates whether the debtor agent guarantees the payment true if a payment guarantee contract exists between the involved parties, otherwise false " } ] }, { "name" "purpose", "kind" "optional", "type" "string", "description" "internal cr field used to include a short description of the purpose of the payment 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" "duplicatedpaymentid", "kind" "optional", "type" "string", "description" "if the payment was duplicated, this field contains the payment id of the duplicate in guid format", "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" "rejectedat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer was rejected, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] if the transfer was not rejected, this field will be null ", "children" \[] }, { "name" "completedat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer was completed, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] if the transfer was not completed, this field will be null ", "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" "timedoutat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer timed out, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] if the transfer did not time out, this field will be null ", "children" \[] }, { "name" "failedat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer failed, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] if the transfer has not failed, this field will be null ", "children" \[] }, { "name" "expiredat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer expired, formatted as yyyy mm ddthh\ mm\ ss\[ mmm] if the transfer has not expired, this field will be null ", "children" \[] }, { "name" "processingstartedat", "kind" "optional", "type" "string", "description" "the date and time when the credit transfer began processing, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "postingcode", "kind" "optional", "type" "string", "description" "indicates the payment status, which may include \n\nok – posted\nres – account restricted\nnsf – insufficient funds in the sending account", "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" "refundspaymentid", "kind" "optional", "type" "string", "description" "the guid representing the id of the payment refund", "children" \[] }, { "name" "sentat", "kind" "optional", "type" "string", "description" "the date and time the credit transfer was sent, formatted as yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "sendattemptcount", "kind" "optional", "type" "integer", "description" "the total count of attempts to send the credit transfer\n", "children" \[] }, { "name" "result", "kind" "optional", "type" "object", "description" "results information", "children" \[ { "name" "code", "kind" "optional", "type" "string", "description" "\na code representing the outcome of the payment \\"ok\\" indicates success, while other codes specify the reason for rejection " }, { "name" "additionalinfo", "kind" "optional", "type" "string", "description" "any additional information" } ] }, { "name" "remittancelocation", "kind" "optional", "type" "object", "description" "remittance location information", "children" \[ { "name" "method", "kind" "optional", "type" "string", "description" "method used to deliver the remittance advice information email or urid" }, { "name" "eaddress", "kind" "optional", "type" "string", "description" "the electronic address where the agent should send the remittance information this is only populated if the method value is email " } ] }, { "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 credit transfer is associated with a previous payment this id is in guid format ", "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" "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" "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), fednow, or crnow ", "children" \[] }, { "name" "queuedpaymentexpiresafterinseconds", "kind" "optional", "type" "string", "description" "the time interval in seconds before a queued payment expires if the receiving fi is offline this is not sent to tch/fed \n\nif both queuedpaymentexpiresat and this attribute are provided, this attribute takes precedence ", "children" \[] } ], "autogeneratedanchorslug" "endpoint rtpv1payments", "legacyhash" "gfpbwlez4ttvea 2izmzl" }