Payment request

relevant webhooks for this endpoint be sure you have docid\ bn5xtgkjogbe ctwomcbs for this webhook docid\ ffgq2ohyebwpzn2old6mc api reference initiates a request for payment (rfp) allows the recipient to authorize and trigger an instant payment credit transfer rfps can be initiated from master account deposit account (dda) associated subledger { "name" "endpoint /rtp/v1/payments/payment request", "method" "post", "url" "https //sandbox crbcos com/rtp/v1/payments/payment request", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "tiu4cyzv2obskcr5taq d", "language" "curl", "code" "curl location 'https //sandbox crbcos com/rtp/v1/payments/payment request' \\\\\n header 'content type application/json' \\\\\n data '{\n \\"accountnumber\\" \\"2564791479\\",\n \\"amount\\" 20000,\n \\"discount\\" 1000,\n \\"debtor\\" {\n \\"routingnumber\\" \\"071212128\\",\n \\"accountnumber\\" \\"2758463448\\",\n \\"name\\" \\"terry tester\\",\n \\"birthcity\\" \\"pine brook\\",\n \\"birthcountry\\" \\"us\\",\n \\"birthdate\\" \\"1996 08 09\\",\n \\"addressstreetname\\" \\"linwood ave\\",\n \\"addressbuildingnumber\\" \\"2115\\",\n \\"addresscity\\" \\"pine brook\\",\n \\"addressstate\\" \\"nj\\",\n \\"addresspostalcode\\" \\"07024\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"creditor\\" {\n \\"accountnumber\\" \\"2564791479\\",\n \\"name\\" \\"the creditor\\"\n },\n \\"purpose\\" \\"test payment 2\\",\n \\"clientidentifier\\" \\"123456\\",\n \\"requestedexecutiondate\\" \\"2025 08 10\\",\n \\"expirydate\\" \\"2025 08 16\\",\n \\"senderid\\" \\"100000001\\",\n \\"usecase\\" \\"businesstobusiness\\",\n \\"industrycategory\\" \\"onlinegaming\\"\n}'", "customlabel" "" }, { "id" "2ywx4qreq r5gxud3qe83", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //sandbox crbcos com/rtp/v1/payments/payment request',\n 'headers' {\n 'content type' 'application/json'\n },\n body json stringify({\n \\"accountnumber\\" \\"2564791479\\",\n \\"amount\\" 20000,\n \\"discount\\" 1000,\n \\"debtor\\" {\n \\"routingnumber\\" \\"071212128\\",\n \\"accountnumber\\" \\"2758463448\\",\n \\"name\\" \\"terry tester\\",\n \\"birthcity\\" \\"pine brook\\",\n \\"birthcountry\\" \\"us\\",\n \\"birthdate\\" \\"1996 08 09\\",\n \\"addressstreetname\\" \\"linwood ave\\",\n \\"addressbuildingnumber\\" \\"2115\\",\n \\"addresscity\\" \\"pine brook\\",\n \\"addressstate\\" \\"nj\\",\n \\"addresspostalcode\\" \\"07024\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"creditor\\" {\n \\"accountnumber\\" \\"2564791479\\",\n \\"name\\" \\"the creditor\\"\n },\n \\"purpose\\" \\"test payment 2\\",\n \\"clientidentifier\\" \\"123456\\",\n \\"requestedexecutiondate\\" \\"2025 08 10\\",\n \\"expirydate\\" \\"2025 08 16\\",\n \\"senderid\\" \\"100000001\\",\n \\"usecase\\" \\"businesstobusiness\\",\n \\"industrycategory\\" \\"onlinegaming\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "yohqfoum8rgbnowxp x0u", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //sandbox crbcos com/rtp/v1/payments/payment request\\"\n\npayload = json dumps({\n \\"accountnumber\\" \\"2564791479\\",\n \\"amount\\" 20000,\n \\"discount\\" 1000,\n \\"debtor\\" {\n \\"routingnumber\\" \\"071212128\\",\n \\"accountnumber\\" \\"2758463448\\",\n \\"name\\" \\"terry tester\\",\n \\"birthcity\\" \\"pine brook\\",\n \\"birthcountry\\" \\"us\\",\n \\"birthdate\\" \\"1996 08 09\\",\n \\"addressstreetname\\" \\"linwood ave\\",\n \\"addressbuildingnumber\\" \\"2115\\",\n \\"addresscity\\" \\"pine brook\\",\n \\"addressstate\\" \\"nj\\",\n \\"addresspostalcode\\" \\"07024\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"creditor\\" {\n \\"accountnumber\\" \\"2564791479\\",\n \\"name\\" \\"the creditor\\"\n },\n \\"purpose\\" \\"test payment 2\\",\n \\"clientidentifier\\" \\"123456\\",\n \\"requestedexecutiondate\\" \\"2025 08 10\\",\n \\"expirydate\\" \\"2025 08 16\\",\n \\"senderid\\" \\"100000001\\",\n \\"usecase\\" \\"businesstobusiness\\",\n \\"industrycategory\\" \\"onlinegaming\\"\n})\nheaders = {\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "po3dr zn2july7vnhkt l", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/rtp/v1/payments/payment request\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"accountnumber\\" \\"2564791479\\",\n \\"amount\\" 20000,\n \\"discount\\" 1000,\n \\"debtor\\" {\n \\"routingnumber\\" \\"071212128\\",\n \\"accountnumber\\" \\"2758463448\\",\n \\"name\\" \\"terry tester\\",\n \\"birthcity\\" \\"pine brook\\",\n \\"birthcountry\\" \\"us\\",\n \\"birthdate\\" \\"1996 08 09\\",\n \\"addressstreetname\\" \\"linwood ave\\",\n \\"addressbuildingnumber\\" \\"2115\\",\n \\"addresscity\\" \\"pine brook\\",\n \\"addressstate\\" \\"nj\\",\n \\"addresspostalcode\\" \\"07024\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"creditor\\" {\n \\"accountnumber\\" \\"2564791479\\",\n \\"name\\" \\"the creditor\\"\n },\n \\"purpose\\" \\"test payment 2\\",\n \\"clientidentifier\\" \\"123456\\",\n \\"requestedexecutiondate\\" \\"2025 08 10\\",\n \\"expirydate\\" \\"2025 08 16\\",\n \\"senderid\\" \\"100000001\\",\n \\"usecase\\" \\"businesstobusiness\\",\n \\"industrycategory\\" \\"onlinegaming\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "puudtha7ybqrhtgmwlbrm", "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/payment request\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"accountnumber\\" \\"2564791479\\",`+\\"\n\\"+`\n \\"amount\\" 20000,`+\\"\n\\"+`\n \\"discount\\" 1000,`+\\"\n\\"+`\n \\"debtor\\" {`+\\"\n\\"+`\n \\"routingnumber\\" \\"071212128\\",`+\\"\n\\"+`\n \\"accountnumber\\" \\"2758463448\\",`+\\"\n\\"+`\n \\"name\\" \\"terry tester\\",`+\\"\n\\"+`\n \\"birthcity\\" \\"pine brook\\",`+\\"\n\\"+`\n \\"birthcountry\\" \\"us\\",`+\\"\n\\"+`\n \\"birthdate\\" \\"1996 08 09\\",`+\\"\n\\"+`\n \\"addressstreetname\\" \\"linwood ave\\",`+\\"\n\\"+`\n \\"addressbuildingnumber\\" \\"2115\\",`+\\"\n\\"+`\n \\"addresscity\\" \\"pine brook\\",`+\\"\n\\"+`\n \\"addressstate\\" \\"nj\\",`+\\"\n\\"+`\n \\"addresspostalcode\\" \\"07024\\",`+\\"\n\\"+`\n \\"addresscountry\\" \\"us\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n \\"creditor\\" {`+\\"\n\\"+`\n \\"accountnumber\\" \\"2564791479\\",`+\\"\n\\"+`\n \\"name\\" \\"the creditor\\"`+\\"\n\\"+`\n },`+\\"\n\\"+`\n \\"purpose\\" \\"test payment 2\\",`+\\"\n\\"+`\n \\"clientidentifier\\" \\"123456\\",`+\\"\n\\"+`\n \\"requestedexecutiondate\\" \\"2025 08 10\\",`+\\"\n\\"+`\n \\"expirydate\\" \\"2025 08 16\\",`+\\"\n\\"+`\n \\"senderid\\" \\"100000001\\",`+\\"\n\\"+`\n \\"usecase\\" \\"businesstobusiness\\",`+\\"\n\\"+`\n \\"industrycategory\\" \\"onlinegaming\\"`+\\"\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(\\"content type\\", \\"application/json\\")\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\\" \\"8ee74810 45fe 47ee 9569 b30500b8d6ae\\",\n \\"originalpaymentid\\" \\"8ee74810 45fe 47ee 9569 b30500b8d6ae\\",\n \\"referenceid\\" \\"r174oi808vyxj\\",\n \\"accountnumber\\" \\"2955057589\\",\n \\"clientidentifier\\" \\"123456\\",\n \\"amount\\" 19000,\n \\"direction\\" \\"outbound\\",\n \\"status\\" \\"created\\",\n \\"paymenttype\\" \\"requestforpayment\\",\n \\"source\\" \\"api\\",\n \\"transactionaccountcontext\\" \\"notsubmitted\\",\n \\"debtor\\" {\n \\"routingnumber\\" \\"011000138\\",\n \\"accountnumber\\" \\"2758463448\\",\n \\"name\\" \\"terry tester\\",\n \\"birthcity\\" \\"pine brook\\",\n \\"birthcountry\\" \\"us\\",\n \\"birthdate\\" \\"1996 08 09\\",\n \\"addressstreetname\\" \\"linwood ave\\",\n \\"addressbuildingnumber\\" \\"2115\\",\n \\"addresscity\\" \\"pine brook\\",\n \\"addressstate\\" \\"nj\\",\n \\"addresspostalcode\\" \\"07024\\",\n \\"addresscountry\\" \\"us\\"\n },\n \\"creditor\\" {\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 \\"network\\" {\n \\"clearingsystemcode\\" \\"tch\\",\n \\"currency\\" \\"usd\\",\n \\"endtoendid\\" \\"6909c29416f0453fbdfdb30500b8d6ae\\",\n \\"instructionid\\" \\"20250623021214273t1b19ts07136537534\\",\n \\"interbanksettlementamount\\" 19000,\n \\"interbanksettlementdate\\" \\"2025 06 23\\",\n \\"messageid\\" \\"m20250623021214273t1bdqk15672530466\\",\n \\"numberoftransactions\\" 1,\n \\"settlementmethod\\" \\"clrg\\",\n \\"businessmessageid\\" \\"b20250623021214273t1bprk46725920502\\",\n \\"toparticipantid\\" \\"990000001s1\\",\n \\"fromparticipantid\\" \\"021214273t1\\",\n \\"instructingroutingnumber\\" \\"021214891\\",\n \\"instructedroutingnumber\\" \\"011000138\\",\n \\"headercreationdate\\" \\"2025 06 23t07 12 58 6058948 04 00\\",\n \\"messagecreationdatetime\\" \\"2025 06 23t07 12 58 6058948 04 00\\",\n \\"createdat\\" \\"2025 06 23t07 12 58 6058948 04 00\\"\n },\n \\"servicelevelcode\\" \\"sdva\\",\n \\"localinstrumentproprietary\\" \\"standard\\",\n \\"categorypurpose\\" \\"consumer\\",\n \\"currency\\" \\"usd\\",\n \\"chargebearer\\" \\"slev\\",\n \\"paymentinfoid\\" \\"20250623021214273t1b19ts07136537534\\",\n \\"reqexecutiondate\\" {\n \\"date\\" \\"2025 08 10t00 00 00 04 00\\",\n \\"datetype\\" \\"dttm\\"\n },\n \\"expirydate\\" {\n \\"date\\" \\"2025 08 16t00 00 00 04 00\\",\n \\"datetype\\" \\"dttm\\"\n },\n \\"paymentconditions\\" {\n \\"amountmodallowed\\" false,\n \\"earlypayallowed\\" true,\n \\"acceptedamount\\" 19000\n },\n \\"purpose\\" \\"test payment 2\\",\n \\"usecase\\" \\"businesstobusiness\\",\n \\"industrycategory\\" \\"onlinegaming\\",\n \\"senderid\\" \\"10000000000\\",\n \\"wasrefunded\\" false,\n \\"waspaid\\" false,\n \\"createdat\\" \\"2025 06 23t07 12 58 6058948 04 00\\",\n \\"productid\\" \\"29f3022a ccfc 42eb aa8f b29500f13d00\\",\n \\"partnerid\\" \\"1101a33d fbd9 4b9e b169 b29500f12407\\",\n \\"lastmodifiedat\\" \\"2025 06 23t07 12 58 6380956 04 00\\",\n \\"sendattemptcount\\" 0,\n \\"discounts\\" \[\n {\n \\"type\\" \\"dsct\\",\n \\"amount\\" 1000,\n \\"currency\\" \\"usd\\"\n },\n {\n \\"type\\" \\"full\\",\n \\"amount\\" 20000,\n \\"currency\\" \\"usd\\"\n }\n ],\n \\"awaitingresponse\\" false,\n \\"networkplatform\\" \\"tch\\"\n}" }, { "id" "on1q4ouolk2zfilk12wlc", "language" "400", "code" "{\n \\"errors\\" \[\n {\n \\"code\\" 2045,\n \\"message\\" \\"receiver does not support request for payment\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "za7e vgg1euptpxfre3cs" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "account from which the rfp is originated" }, { "name" "amount", "kind" "required", "type" "integer", "description" "requested payment amount in positive integeral cents for example, represent $1 00 as 100 ", "children" \[] }, { "name" "purpose", "kind" "optional", "type" "string", "description" "internal cr field used to include a short description or purpose for the payment request the rdfi does not see this field 50 characters maximum ", "children" \[] }, { "name" "requestedexecutiondate", "kind" "required", "type" "string", "description" "date when the payment request needs to be processed by the debtor formatted as yyyy mm ddthh\ mm\ ss\[ mmm] ", "children" \[] }, { "name" "expirydate", "kind" "required", "type" "string", "description" "expiration date and time of the rfp if no time is specified, it expires at 12 00 am on the given date if a time is provided, it expires within one hour after the specified time on the same date formatted as yyyy mm ddthh\ mm\ ss\[ mmm] ", "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 50 characters maximum ", "children" \[] }, { "name" "remittancedata", "kind" "optional", "type" "string", "description" "a description of the payment request, 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" "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" "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" "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" "routingnumber", "kind" "required", "type" "string", "description" "9 digit routing number of the financial institution" }, { "name" "phonenumber", "kind" "optional", "type" "string", "description" "10 characters maximum" } ] }, { "name" "ultimatedebtor", "kind" "optional", "type" "object", "description" "ultimate debtor business/individual information the final party receiving the rfp and responsible for initiating the credit transfer upon authorization ", "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" "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" "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" "phonenumber", "kind" "optional", "type" "string", "description" "10 characters maximum" } ] }, { "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" "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" "usecase", "kind" "required", "type" "string", "description" "use one of the following values for the usecase field \n\n businesstobusiness\n consumerbillpay\n accounttoaccount\n downpaymentorfinalpayment\n consumertogovernment", "" "use one of the following values for the usecase field \n\n businesstobusiness\n consumerbillpay\n accounttoaccount\n downpaymentorfinalpayment\n consumertogovernment" }, { "name" "industrycategory", "kind" "optional", "type" "string", "description" "use one of the following values for the industrycategory field (optional when usecase is businesstobusiness or consumertogovernment) \n\n homeutilities\n telecomutilities\n mortgage\n rent\n insurancepremiums\n autoloans\n personalloans\n creditcardpayment\n mediasubscriptions\n memberships\n financialinstitution\n brokerordealer\n medical\n onlinegaming\n realestate\n government", "" "use one of the following values for the industrycategory field (optional when usecase is businesstobusiness or consumertogovernment) \n\n homeutilities\n telecomutilities\n mortgage\n rent\n insurancepremiums\n autoloans\n personalloans\n creditcardpayment\n mediasubscriptions\n memberships\n financialinstitution\n brokerordealer\n medical\n onlinegaming\n realestate\n government" }, { "name" "senderid", "kind" "required", "type" "string", "description" "use the senderid field (optional when usecase is businesstobusiness or consumertogovernment), provided by cross river and generated by the clearing house (tch) \n\nvalid senderid's for sandbox testing \n 100000000001\n 100000000002\n 100000000003\n 100000000004\n 100000000005", "" "required" }, { "name" "amountmodallowed", "kind" "optional", "type" "boolean", "description" "indicates whether the recipient is allowed to modify the requested amount in response to an rfp if the field is not provided, the system defaults to true \nif true, the recipient may respond with a different amount\nif false, the recipient must match the original amount; any mismatch will cause the payment to be rejected \n", "" "indicates whether the recipient is allowed to modify the requested amount in response to an rfp if the field is not provided, the system defaults to true \nif true, the recipient may respond with a different amount\nif false, the recipient must match the original amount; any mismatch will cause the payment to be rejected \n" } ], "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 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 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 of the memo post have been removed\n", "children" \[] }, { "name" "direction", "kind" "optional", "type" "string", "description" "outbound for an outbound payment request or inbound for an inbound payment request ", "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 requestforpayment", "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" "rtptransactionstatus", "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 – 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 \n", "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" "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 message" }, { "name" "messageid", "kind" "optional", "type" "string", "description" "unique identifier of the message" }, { "name" "createdat", "kind" "optional", "type" "string", "description" "indicates when the pain 013 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 payment requ while it remains active within the rtp system \n\nthis id serves as the unique identifier for the payment request within the instant payments network " }, { "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 receives 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 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 (commonly known as a uetr) is a string of 36 unique characters featured in all payment instruction messages carried over swift " } ] }, { "name" "remittanceadvice", "kind" "optional", "type" "object", "description" "remittance advice information", "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 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" "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 payment request ", "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 remittance advice ", "children" \[] }, { "name" "remittancedata", "kind" "optional", "type" "string", "description" "a description of the payment request, serving as the remittance advice this field is used for any remittance information that does not have a designated field ", "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" "amountmodallowed", "kind" "optional", "type" "boolean", "description" "indicates whether the requested payment amount can be modified by the debtor " }, { "name" "earlypayallowed", "kind" "optional", "type" "boolean", "description" "specifies if early payment is permitted before the due date " }, { "name" "acceptedamount", "kind" "optional", "type" "integer", "description" "the fixed amount (in cents) that the creditor is willing to accept for the payment request " } ] }, { "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" "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" "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", "children" \[] }, { "name" "discounts", "kind" "optional", "type" "object", "description" "discounts array specifies applicable discounts for the 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 (e g , 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" "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" \[] } ] }