Simulate inbound origination

api reference simulate receiving an rtp or fednow credit transfer payment from another financial institution this api can only be run in the cross river sandbox docid kaqyvqvnuagqnekfkcuy { "name" "endpoint /rtp/payments/simulated inbound origination", "method" "post", "url" "https //sandbox crbcos com/rtp/v1/payments/simulated inbound origination", "tab" "examples", "examples" { "languages" \[ { "id" "curl example", "language" "curl", "code" "curl x post https //sandbox crbcos com/rtp/v1/payments/simulated inbound origination \\\\\\\\\n h \\"authorization bearer your access token\\" \\\\\\\\\n h \\"content type application/json\\" \\\\\\\\\n d '{\n \\"accountnumber\\" \\"1234567890\\",\n \\"amount\\" 150000,\n \\"debtor\\" {},\n \\"remittancedata\\" \\"sample value\\",\n \\"remittancereferredinfo\\" \[]\n}'" }, { "id" "nodejs example", "language" "nodejs", "code" "const axios = require('axios');\n\nconst options = {\n method 'post',\n url 'https //sandbox crbcos com/rtp/v1/payments/simulated inbound origination',\n headers {\n 'authorization' 'bearer your access token',\n 'content type' 'application/json',\n },\n data {\n \\"accountnumber\\" \\"1234567890\\",\n \\"amount\\" 150000,\n \\"debtor\\" {},\n \\"remittancedata\\" \\"sample value\\",\n \\"remittancereferredinfo\\" \[]\n}\n};\n\naxios(options)\n then(response => console log(response data))\n catch(error => console error(error));" }, { "id" "python example", "language" "python", "code" "import requests\n\nurl = 'https //sandbox crbcos com/rtp/v1/payments/simulated inbound origination'\nheaders = {\n 'authorization' 'bearer your access token',\n 'content type' 'application/json',\n}\ndata = {\n \\"accountnumber\\" \\"1234567890\\",\n \\"amount\\" 150000,\n \\"debtor\\" {},\n \\"remittancedata\\" \\"sample value\\",\n \\"remittancereferredinfo\\" \[]\n}\n\nresponse = requests post(url, headers=headers, json=data)\nprint(response json())" }, { "id" "ruby example", "language" "ruby", "code" "require 'net/http'\nrequire 'json'\n\nuri = uri('https //sandbox crbcos com/rtp/v1/payments/simulated inbound origination')\nhttp = net http new(uri host, uri port)\nhttp use ssl = true\n\nrequest = net http post new(uri)\nrequest\['authorization'] = 'bearer your access token'\nrequest\['content type'] = 'application/json'\nrequest body = {\n \\"accountnumber\\" \\"1234567890\\",\n \\"amount\\" 150000,\n \\"debtor\\" {},\n \\"remittancedata\\" \\"sample value\\",\n \\"remittancereferredinfo\\" \[]\n} to json\n\nresponse = http request(request)\nputs json parse(response body)" }, { "id" "go example", "language" "go", "code" "package main\n\nimport (\n \\"bytes\\"\n \\"encoding/json\\"\n \\"fmt\\"\n \\"io/ioutil\\"\n \\"net/http\"\n)\n\nfunc main() {\n payload = \[]byte(`{\n \\"accountnumber\\" \\"1234567890\\",\n \\"amount\\" 150000,\n \\"debtor\\" {},\n \\"remittancedata\\" \\"sample value\\",\n \\"remittancereferredinfo\\" \[]\n}`)\n\n req, = http newrequest(\\"post\\", \\"https //sandbox crbcos com/rtp/v1/payments/simulated inbound origination\\", bytes newbuffer(payload))\n req header add(\\"authorization\\", \\"bearer your access token\\")\n req header add(\\"content type\\", \\"application/json\\")\n\n client = \&http client{}\n resp, err = client do(req)\n if err != nil {\n panic(err)\n }\n defer resp body close()\n\n body, = ioutil readall(resp body)\n fmt println(string(body))\n}" } ] }, "results" { "languages" \[ { "id" "202", "language" "202", "code" "" }, { "id" "400", "language" "400", "code" "{\\\n \\\\\\"errors\\\\\\" \[{\\\n \\\\\\"code\\\\\\" 2001,\\\n \\\\\\"message\\\\\\" \\\\\\"validation error\\\\\\"\\\n }]\\\n}" }, { "id" "401", "language" "401", "code" "{\\\n \\\\\\"errors\\\\\\" \[{\\\n \\\\\\"code\\\\\\" 3001,\\\n \\\\\\"message\\\\\\" \\\\\\"unauthorized\\\\\\"\\\n }]\\\n}" } ] }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "formdataparameters" \[], "bodydataparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "a valid cos account number associated to the transaction this parameter can be null " }, { "name" "amount", "kind" "required", "type" "integer", "description" "dollar amount of the transaction in positive integral cents for example, write $1 00 as 100 " }, { "name" "debtor", "kind" "required", "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" "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" "routingnumber", "kind" "optional", "type" "string", "description" "9 digit aba routing number that identifies the originator financial institution" }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "a valid cos account number associated to the transaction this parameter can be null " }, { "name" "name", "kind" "optional", "type" "string", "description" "bank name" }, { "name" "birthcity", "kind" "required", "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" "beneficiary birthdate in the format 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" "the beneficiary phone number" } ] }, { "name" "remittancedata", "kind" "required", "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 " }, { "name" "remittancereferredinfo", "kind" "required", "type" "array", "description" "remittancereferredinfo" }, { "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) " }, { "name" "uetr", "kind" "optional", "type" "string", "description" "uetr" }, { "name" "purpose", "kind" "optional", "type" "string", "description" "reason for the ach transfer for internal use only the data is not included with the outgoing ach batch file " }, { "name" "localinstrument", "kind" "optional", "type" "string", "description" "localinstrument" } ] }, "response" \[], "description" "", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "autogeneratedanchorslug" "endpoint rtppaymentssimulated inbound origination", "legacyhash" "i9o9co7boalofbg4fbcpi" } use cases test receiving instant payments in sandbox environment validate payment processing workflows without real network transmission develop and debug payment receipt handling before production train support staff on payment receipt scenarios error codes code scenario resolution 2013 routing number isn't a valid rtp participant verify request parameters and retry 3001 unauthorized verify bearer token is valid and not expired 3002 insufficient permissions verify user has required permission for this operation business rules requires valid bearer token with permissions permissions payments simulate remittancedata field is limited to 140 characters maximum request validation performed before processing errors return 400 bad request with detailed error information rate limiting may apply to prevent abuse