--- title: Get extended check data slug: apis/payments/checks/get-extended-check-data description: Retrieve a specific payment by its unique identifier icon: {"apiMethod":"GET"} docTags: createdAt: 2026-07-14T13:17:09.000Z --- ## API reference Returns a specific payment by its unique identifier :::ApiMethodV2 ```json { "name": "Endpoint: /v1/payments/{id}/extended", "method": "GET", "url": "https://sandbox.crbcos.com/checks/v1/payments/{id}/extended", "tab": "examples", "examples": { "languages": [ { "id": "curl-example", "language": "curl", "code": "curl --location 'https://sandbox.crbcos.com/checks/v1/payments/3d70fc63-672e-4c3b-9e66-b48700b5db14/extended' \\\n--data ''" }, { "id": "nodejs-example", "language": "nodejs", "code": "var https = require('follow-redirects').https;\nvar fs = require('fs');\n\nvar options = {\n 'method': 'GET',\n 'hostname': 'sandbox.crbcos.com',\n 'path': '/checks/v1/payments/3d70fc63-672e-4c3b-9e66-b48700b5db14/extended',\n 'headers': {\n },\n 'maxRedirects': 20\n};\n\nvar req = https.request(options, function (res) {\n var chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function (chunk) {\n var body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n\n res.on(\"error\", function (error) {\n console.error(error);\n });\n});\n\nreq.end();" }, { "id": "python-example", "language": "python", "code": "import requests\n\nurl = \"https://sandbox.crbcos.com/checks/v1/payments/3d70fc63-672e-4c3b-9e66-b48700b5db14/extended\"\n\npayload = \"\"\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "ruby-example", "language": "ruby", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"https://sandbox.crbcos.com/checks/v1/payments/3d70fc63-672e-4c3b-9e66-b48700b5db14/extended\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "go-example", "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/checks/v1/payments/3d70fc63-672e-4c3b-9e66-b48700b5db14/extended\"\n method := \"GET\"\n\n payload := strings.NewReader(``)\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 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}" } ], "selectedLanguageId": "curl-example" }, "results": { "languages": [ { "id": "200", "language": "200", "code": "{\n \"extended\": {\n \"cashLetter\": {\n \"recordType\": \"10\",\n \"collectionTypeIndicator\": \"01\",\n \"destinationRoutingNumber\": \"061000146\",\n \"eceInstitutionRoutingNumber\": \"021214891\",\n \"businessDate\": \"20260714\",\n \"creationDate\": \"20260714\",\n \"creationTime\": \"0702\",\n \"recordTypeIndicator\": \"I\",\n \"documentationTypeIndicator\": \"G\",\n \"cashLetterId\": \"03743251\",\n \"originatorContactName\": \"\",\n \"originatorContactPhone\": \"\",\n \"fedWorkType\": \"C\"\n },\n \"bundle\": {\n \"recordType\": \"20\",\n \"collectionTypeIndicator\": \"01\",\n \"destinationRoutingNumber\": \"061000146\",\n \"eceRoutingNumber\": \"021214891\",\n \"businessDate\": \"20260714\",\n \"creationDate\": \"20260714\",\n \"bundleId\": \"69236621\",\n \"sequenceNumber\": \"1\",\n \"cycleNumber\": \"0\",\n \"returnLocationRoutingNumber\": \"021214891\"\n },\n \"item\": {\n \"checkDetail\": {\n \"recordType\": \"25\",\n \"auxiliaryOnUs\": \"1237\",\n \"externalProcessingCode\": \"\",\n \"payorRoutingNumber\": \"31407426\",\n \"payorCheckDigit\": \"9\",\n \"onUs\": \"/28293886\",\n \"amount\": \"10000\",\n \"sequenceNumber\": \"3918624417\",\n \"documentationTypeIndicator\": \"G\",\n \"electronicReturnIndicator\": \"\",\n \"micrValidIndicator\": \" \",\n \"bofdIndicator\": \"Y\",\n \"addendumCount\": \"01\",\n \"correctionIndicator\": \"\",\n \"archiveTypeIndicator\": \"\"\n },\n \"checkAddendumA\": [\n {\n \"recordType\": \"26\",\n \"recordNumber\": \"1\",\n \"bofdRoutingNumber\": \"021214891\",\n \"bofdBusinessDate\": \"20260714\",\n \"bofdSequenceNumber\": \"3918624417\",\n \"bofdDepositAccountNumber\": \"2203250853\",\n \"bofdDepositBranch\": \"01\",\n \"payeeName\": \"\",\n \"truncationIndicator\": \"Y\",\n \"bofdConversionIndicator\": \"\",\n \"bofdCorrectionIndicator\": \"\",\n \"userField\": \"\",\n \"reserved\": \"\"\n }\n ],\n \"checkAddendumB\": [],\n \"checkAddendumC\": [],\n \"returnAddendumA\": [],\n \"returnAddendumD\": [],\n \"images\": [\n {\n \"detail\": {\n \"recordType\": \"50\",\n \"imageIndicator\": \"1\",\n \"creatorRoutingNumber\": \"021214891\",\n \"creatorDate\": \"20260714\",\n \"imageViewFormatIndicator\": \"00\",\n \"imageViewCompression\": \"00\",\n \"imageViewDataSize\": \"5652\",\n \"viewSideIndicator\": \"0\",\n \"viewDescriptor\": \"00\",\n \"digitalSignatureIndicator\": \"0\",\n \"digitalSignatureMethod\": \"\",\n \"securityKeySize\": \"\",\n \"startOfProtectedData\": \"\",\n \"lengthOfProtectedData\": \"\",\n \"imageRecreateIndicator\": \"\",\n \"userField\": \"\",\n \"reserved\": \"\"\n },\n \"data\": {\n \"recordType\": \"52\",\n \"institutionRoutingNumber\": \"021214891\",\n \"bundleBusinessDate\": \"20260714\",\n \"cycleNumber\": \"0\",\n \"eceSequenceNumber\": \"3918624417\",\n \"securityOriginatorName\": \"\",\n \"securityAuthenticatorName\": \"\",\n \"securityKeyName\": \"\",\n \"clippingOrigin\": \"0\",\n \"clippingCoordinateH1\": \"\",\n \"clippingCoordinateH2\": \"\",\n \"clippingCoordinateV1\": \"\",\n \"clippingCoordinateV2\": \"\",\n \"lengthOfReferenceKey\": \"19\",\n \"imageReferenceKey\": \"2026071439186244170\",\n \"lengthOfSignature\": \"0000\",\n \"digitalSignature\": \"\",\n \"lengthOfImageData\": \"5652\",\n \"imageData\": \"payment_3366874c-b887-4532-aec7-b48c006d4d1f_0.tif\"\n },\n \"analysis\": {\n \"recordType\": \"54\",\n \"globalImageQuality\": \"0\",\n \"globalImageUsability\": \"0\",\n \"imagingBankSpecficTest\": \"0\",\n \"partialImage\": \"0\",\n \"excessiveImageSkew\": \"0\",\n \"piggybackImage\": \"0\",\n \"tooLightOrTooDark\": \"0\",\n \"streaksAndBands\": \"0\",\n \"belowMinimumImageSize\": \"0\",\n \"exceedsMaximumImageSize\": \"0\",\n \"reserved1\": \"\",\n \"reserved2\": \"\",\n \"reserved3\": \"\",\n \"reserved4\": \"\",\n \"reserved5\": \"\",\n \"reserved6\": \"\",\n \"reserved7\": \"\",\n \"reserved8\": \"\",\n \"reserved9\": \"\",\n \"reserved10\": \"\",\n \"reserved11\": \"\",\n \"reserved12\": \"\",\n \"reserved13\": \"\",\n \"imageEnabledPod\": \"0\",\n \"sourceDocumentBad\": \"0\",\n \"dateUsability\": \"0\",\n \"payeeUsability\": \"0\",\n \"convenienceAmountUsability\": \"0\",\n \"wordsAmountUsability\": \"0\",\n \"signatureUsability\": \"0\",\n \"payorNameUsability\": \"0\",\n \"micrLineUsability\": \"0\",\n \"memoLineUsability\": \"0\",\n \"payorBankNameUsability\": \"0\",\n \"payeeEndorsementUsability\": \"0\",\n \"bofdEndorsementUsability\": \"0\",\n \"transitEndorsementUsability\": \"0\",\n \"reserved14\": \"\",\n \"reserved15\": \"\",\n \"reserved16\": \"\",\n \"reserved17\": \"\",\n \"reserved18\": \"\",\n \"reserved19\": \"\",\n \"userField\": \"00000000000000000000\",\n \"reserved20\": \"\"\n },\n \"recordCount\": 3\n },\n {\n \"detail\": {\n \"recordType\": \"50\",\n \"imageIndicator\": \"1\",\n \"creatorRoutingNumber\": \"021214891\",\n \"creatorDate\": \"20260714\",\n \"imageViewFormatIndicator\": \"00\",\n \"imageViewCompression\": \"00\",\n \"imageViewDataSize\": \"3132\",\n \"viewSideIndicator\": \"1\",\n \"viewDescriptor\": \"00\",\n \"digitalSignatureIndicator\": \"0\",\n \"digitalSignatureMethod\": \"\",\n \"securityKeySize\": \"\",\n \"startOfProtectedData\": \"\",\n \"lengthOfProtectedData\": \"\",\n \"imageRecreateIndicator\": \"\",\n \"userField\": \"\",\n \"reserved\": \"\"\n },\n \"data\": {\n \"recordType\": \"52\",\n \"institutionRoutingNumber\": \"021214891\",\n \"bundleBusinessDate\": \"20260714\",\n \"cycleNumber\": \"0\",\n \"eceSequenceNumber\": \"3918624417\",\n \"securityOriginatorName\": \"\",\n \"securityAuthenticatorName\": \"\",\n \"securityKeyName\": \"\",\n \"clippingOrigin\": \"0\",\n \"clippingCoordinateH1\": \"\",\n \"clippingCoordinateH2\": \"\",\n \"clippingCoordinateV1\": \"\",\n \"clippingCoordinateV2\": \"\",\n \"lengthOfReferenceKey\": \"19\",\n \"imageReferenceKey\": \"2026071439186244171\",\n \"lengthOfSignature\": \"0000\",\n \"digitalSignature\": \"\",\n \"lengthOfImageData\": \"3132\",\n \"imageData\": \"payment_3366874c-b887-4532-aec7-b48c006d4d1f_1.tif\"\n },\n \"analysis\": {\n \"recordType\": \"54\",\n \"globalImageQuality\": \"0\",\n \"globalImageUsability\": \"0\",\n \"imagingBankSpecficTest\": \"0\",\n \"partialImage\": \"0\",\n \"excessiveImageSkew\": \"0\",\n \"piggybackImage\": \"0\",\n \"tooLightOrTooDark\": \"0\",\n \"streaksAndBands\": \"0\",\n \"belowMinimumImageSize\": \"0\",\n \"exceedsMaximumImageSize\": \"0\",\n \"reserved1\": \"\",\n \"reserved2\": \"\",\n \"reserved3\": \"\",\n \"reserved4\": \"\",\n \"reserved5\": \"\",\n \"reserved6\": \"\",\n \"reserved7\": \"\",\n \"reserved8\": \"\",\n \"reserved9\": \"\",\n \"reserved10\": \"\",\n \"reserved11\": \"\",\n \"reserved12\": \"\",\n \"reserved13\": \"\",\n \"imageEnabledPod\": \"0\",\n \"sourceDocumentBad\": \"0\",\n \"dateUsability\": \"0\",\n \"payeeUsability\": \"0\",\n \"convenienceAmountUsability\": \"0\",\n \"wordsAmountUsability\": \"0\",\n \"signatureUsability\": \"0\",\n \"payorNameUsability\": \"0\",\n \"micrLineUsability\": \"0\",\n \"memoLineUsability\": \"0\",\n \"payorBankNameUsability\": \"0\",\n \"payeeEndorsementUsability\": \"0\",\n \"bofdEndorsementUsability\": \"0\",\n \"transitEndorsementUsability\": \"0\",\n \"reserved14\": \"\",\n \"reserved15\": \"\",\n \"reserved16\": \"\",\n \"reserved17\": \"\",\n \"reserved18\": \"\",\n \"reserved19\": \"\",\n \"userField\": \"00000000000000000000\",\n \"reserved20\": \"\"\n },\n \"recordCount\": 3\n }\n ],\n \"recordCount\": 8\n }\n },\n \"id\": \"3d70fc63-672e-4c3b-9e66-b48700b5db14\",\n \"accountNumber\": \"2203250853\",\n \"referenceId\": \"C195BV23Y5FM\",\n \"paymentType\": \"Forward\",\n \"checkType\": \"Standard\",\n \"direction\": \"Outbound\",\n \"status\": \"Completed\",\n \"source\": \"Api\",\n \"posting\": \"Posted\",\n \"postingCode\": \"OK\",\n \"fedBatchId\": \"b27a0427-1434-4372-ae16-b488015f31cc\",\n \"fedBatchSequence\": 1,\n \"coreTransactionId\": \"4c8d9f31-4072-466a-b64a-b48700b5db14\",\n \"memoPostId\": \"05a58583-6a53-449c-b685-b48700b5db14\",\n \"originalPaymentId\": \"3d70fc63-672e-4c3b-9e66-b48700b5db14\",\n \"customerId\": \"861261af-1251-49e8-966f-b2ff00d627bd\",\n \"payerRoutingNumber\": \"314074269\",\n \"payerAccountNumber\": \"28293886\",\n \"payeeName\": \"\",\n \"checkNumber\": \"1237\",\n \"bofdRoutingNumber\": \"021214891\",\n \"sequenceNumber\": \"3918624417\",\n \"amount\": 10000,\n \"currency\": \"usd\",\n \"micr\": \"d314074269dc28293886c1237\",\n \"recognizedAmount\": 100,\n \"iqaPassed\": true,\n \"hasFrontImage\": true,\n \"hasBackImage\": true,\n \"isRedeposit\": false,\n \"policy\": \"Standard\",\n \"schedule\": [\n 0,\n 10000\n ],\n \"createdAt\": \"2026-07-14T07:02:06.997-04:00\",\n \"processedAt\": \"2026-07-15T17:18:53.033-04:00\",\n \"completedAt\": \"2026-07-15T17:18:53.033-04:00\",\n \"postedAt\": \"2026-07-15T17:18:53.25-04:00\",\n \"wasReturned\": true,\n \"purpose\": \"SKIP_IQA\",\n \"depositBusinessDate\": \"260715\",\n \"decisionRequired\": false,\n \"wasDecisioned\": false,\n \"productId\": \"83bed086-8182-4151-a1e3-af5b01362783\",\n \"partnerId\": \"cd9c12f4-7691-424a-b38b-af5b0134c611\",\n \"lastModifiedAt\": \"2026-07-19T02:37:57.2846515-04:00\"\n}" }, { "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}" } ], "selectedLanguageId": "200" }, "request": { "pathParameters": [ { "name": "id", "type": "string", "kind": "required", "description": "Payment ID of the specific payment. Find this ID in the response to a deposit check call, or in the Check.Payment.Received webhook.", "": "Payment ID of the specific payment. Find this ID in the response to a deposit check call, or in the Check.Payment.Received webhook." } ], "queryParameters": [], "headerParameters": [], "formDataParameters": [], "bodyDataParameters": [] }, "response": [ { "name": "id", "kind": "returned", "type": "string", "description": "Check payment ID. This ID is in GUID format." }, { "name": "accountNumber", "kind": "returned", "type": "string", "description": "Number of the account the check is posting to" }, { "name": "referenceId", "kind": "returned", "type": "string", "description": "The reference ID of the check payment, indicating the rail type in the first element of the string. In this case it is C. This is an internal Cross River attribute." }, { "name": "paymentType", "kind": "returned", "type": "string", "description": "The check paymentType indicates whether the check has been presented for payment or has been returned for some reason:\n\n- Forward (a check presented for payment, to be sent to the payer bank)\n- Return (A previous forward item that the payer bank returned)" }, { "name": "checkType", "kind": "returned", "type": "string", "description": "Type of check being dealt with. There are several check types:\n- Standard\n- OnUs\n- Treasury\n- MoneyOrder\n- FedReserveBank\n- FedHomeLoan\n- StateLocalGovt\n- Certified\n- Unknown" }, { "name": "direction", "kind": "returned", "type": "string", "description": "Payment direction:\n- Inbound\n- Outbound" }, { "name": "status", "kind": "returned", "type": "string", "description": "Status of the positive pay record:\n\n- Authorized\n- Paid\n- Revoked" }, { "name": "source", "kind": "returned", "type": "string", "description": "Source of the payment request:\n- Api\n- PartnerPortal\n- OpsPortal\n- File\n- System\n- Lockbox" }, { "name": "posting", "kind": "returned", "type": "string", "description": "Posting status:\n- Pending\n- Posted\n- Failed\n- Canceled\n- Authorized\n- Authorizing" }, { "name": "rejectionReason", "kind": "returned", "type": "string", "description": "Rejected because:\n- ImageAnalysisFailure\n- PostingException\n- AmountMismatch\n- MaxItemAmountExceeded\n- MaxDepositAmountExceeded\n- MaxItemsPerDayExceeded\n- Duplicate\n- PayerRoutingNumberInvalid\n- PayerAccountNumberInvalid\n- CheckNumberInvalid\n- AccountNotFound\n- DepositsNotEnabled\n- InvalidAccountType\n- NotSpecified" }, { "name": "positivePayResult", "kind": "returned", "type": "string", "description": "If Positive Pay is enabled, the positive pay status of the check:\n- Pending\n- Authorized\n- Unauthorized\n- Disabled" }, { "name": "positivePayMatchId", "kind": "returned", "type": "string", "description": "If Positive Pay is enabled, ID of the positive pay record associated with the payment" }, { "name": "postingCode", "kind": "returned", "type": "string", "description": "Code related to the Cross River system transaction tied to the payment. Any value other than “OK” indicates a rejection." }, { "name": "clientBatchId", "kind": "returned", "type": "string", "description": "ID for the batch received from the Cross River lockbox vendor" }, { "name": "clientBatchSequence", "kind": "returned", "type": "integer", "description": "Sequence number of the payment inside the batch received from the Cross River lockbox vendor" }, { "name": "fedBatchId", "kind": "returned", "type": "string", "description": "ID of the distribution that the check was included in" }, { "name": "fedBatchSequence", "kind": "returned", "type": "integer", "description": "Sequence number of the payment inside the distribution" }, { "name": "coreTransactionId", "kind": "returned", "type": "string", "description": "Unique Cross River identifier for the core transaction. This ID is in GUID format." }, { "name": "memoPostId", "kind": "returned", "type": "string", "description": "Unique identifier for the memo post. This ID is in GUID format." }, { "name": "originalPaymentId", "kind": "returned", "type": "string", "description": "The original payment ID, when a check has been returned or redeposited" }, { "name": "customerId", "kind": "returned", "type": "string", "description": "The unique ID assigned to a customer when the customer record is created. You need this ID to take action for a specific customer. For example, when opening an account or adding an address to a customer record.\nThe ID is in GUID format." }, { "name": "payerRoutingNumber", "kind": "returned", "type": "string", "description": "The payer’s routing number (printed on the check)" }, { "name": "payerAccountNumber", "kind": "returned", "type": "string", "description": "The payer’s account number (printed on the check)" }, { "name": "payeeName", "kind": "returned", "type": "string", "description": "Name of the payee from the check, up to 15 characters (X9.37 Field 8)" }, { "name": "checkNumber", "kind": "returned", "type": "string", "description": "The serial number that appears on the check.\n20 characters maximum" }, { "name": "bofdRoutingNumber", "kind": "returned", "type": "string", "description": "Nine-digit routing and transit number (TTTTAAAAC format) of the Bank of First Deposit (X9.37 Field 3)" }, { "name": "sequenceNumber", "kind": "returned", "type": "string", "description": "Sequential number of this bundle within the cash letter, typically denoting relative position (X9.37 Field 8)" }, { "name": "amount", "kind": "returned", "type": "integer", "description": "The amount to be transferred, in cents. For example, 10001 = $100.01." }, { "name": "currency", "kind": "returned", "type": "string", "description": "Currency of the check. For example, USD (US dollars)" }, { "name": "micr", "kind": "returned", "type": "string", "description": "The magnetic ink character recognition line, consisting of the routing number, account number and check number" }, { "name": "recognizedAmount", "kind": "returned", "type": "integer", "description": "The check amount recognized from the check image via OCR" }, { "name": "iqaPassed", "kind": "returned", "type": "boolean", "description": "True if the check has passed the Fed’s image quality assurance standards, otherwise false" }, { "name": "returnCode", "kind": "returned", "type": "string", "description": "The return code indicates why the check was returned. There are several return codes." }, { "name": "hasFrontImage", "kind": "returned", "type": "boolean", "description": "True if the check image file includes the front of the check. Otherwise false." }, { "name": "hasBackImage", "kind": "returned", "type": "boolean", "description": "True if the check image file includes the back of the check. Otherwise false." }, { "name": "isRedeposit", "kind": "returned", "type": "boolean", "description": "True if the check was deposited before. Otherwise false." }, { "name": "policy", "kind": "returned", "type": "string", "description": "Policy" }, { "name": "schedule", "kind": "returned", "type": "array", "description": "Funds availability schedule, determined by the policy, and based on whenever the check was released to the Fed in a distribution. Consists of a day-by-day breakdown based on calendar day, with each day’s availability amount displayed." }, { "name": "createdAt", "kind": "returned", "type": "string", "description": "The date and time the record was created. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]" }, { "name": "canceledAt", "kind": "returned", "type": "string", "description": "Date and time the check payment was canceled. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]" }, { "name": "rejectedAt", "kind": "returned", "type": "string", "description": "Date and time the check payment was rejected. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]" }, { "name": "processedAt", "kind": "returned", "type": "string", "description": "Date and time the check payment was processed. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]" }, { "name": "completedAt", "kind": "returned", "type": "string", "description": "Date and time the check payment was completed. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]" }, { "name": "postedAt", "kind": "returned", "type": "string", "description": "Date and time the check payment was posted In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]" }, { "name": "wasReturned", "kind": "returned", "type": "boolean", "description": "True if the check was returned. Otherwise false." }, { "name": "purpose", "kind": "returned", "type": "string", "description": "Purpose of the deposited check" }, { "name": "clientIdentifier", "kind": "returned", "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.\n\n50 characters maximum" }, { "name": "depositBusinessDate", "kind": "returned", "type": "string", "description": "The business date of the deposit in the format of yymmdd. This date is usually Day 1 of the schedule for making the funds available. If the check is deposited after the day's deposit cut-off time, Day 1 might be a different date. In that case, the processedAt date is Day 1." }, { "name": "lockboxVendorId", "kind": "returned", "type": "string", "description": "ID of the lockbox service receiving the paper checks and sending them via ICL to Cross River" }, { "name": "decisionRequired", "kind": "returned", "type": "boolean", "description": "DecisionRequired" }, { "name": "wasDecisioned", "kind": "returned", "type": "boolean", "description": "WasDecisioned" }, { "name": "productId", "kind": "returned", "type": "string", "description": "ID in GUID format of your specific product type on which the account is based. Provided by Cross River. In this case, it's the product ID of the payee account." }, { "name": "partnerId", "kind": "optional", "type": "string", "description": "Your unique ID in the Cross River system. This ID is in GUID format.", "children": [] }, { "name": "lastModifiedAt", "kind": "optional", "type": "string", "description": "Internal Cross River value. Date and time the database entry was last modified. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]", "children": [] }, { "name": "extended", "kind": "returned", "type": "object", "description": "Extended X9.37 Image Cash Letter (ICL) data containing the complete cash letter header, bundle header, and check item details per ANSI X9.37 specification", "children": [ { "name": "cashLetter", "kind": "optional", "type": "object", "description": "X9.37 Cash Letter Header (Record Type 10) containing metadata about the entire cash letter transmission", "children": [ { "name": "collectionTypeIndicator", "kind": "optional", "type": "string", "description": "Code identifying the type of collection: 00=Preliminary Forward, 01=Forward Presentment, 02=Same-Day Settlement, 03=Return, 04=Return Notification, 05=Preliminary Return Notification, 06=Final Return Notification, 20=No Detail, 99=Mixed collection types (X9.37 Field 2)" }, { "name": "destinationRoutingNumber", "kind": "optional", "type": "string", "description": "Nine-digit routing and transit number (TTTTAAAAC format) of the institution that receives and processes the cash letter (X9.37 Field 3)" }, { "name": "eceInstitutionRoutingNumber", "kind": "optional", "type": "string", "description": "Nine-digit routing and transit number (TTTTAAAAC format) of the ECE (Exchange) institution that creates the cash letter (X9.37 Field 4)" }, { "name": "businessDate", "kind": "optional", "type": "string", "description": "Business date of the cash letter in YYYYMMDD format (X9.37 Field 5)" }, { "name": "creationDate", "kind": "optional", "type": "string", "description": "Date the cash letter was created in Eastern Time zone, YYYYMMDD format (X9.37 Field 6)" }, { "name": "creationTime", "kind": "optional", "type": "string", "description": "Time the cash letter was created in Eastern Time zone, HHMM format using 24-hour notation (X9.37 Field 7)" }, { "name": "recordTypeIndicator", "kind": "optional", "type": "string", "description": "Indicates the presence and type of electronic check records: N=No electronic records, E=Electronic records without images, I=Electronic records with images, F=Electronic records with images from previous letter (X9.37 Field 8)" }, { "name": "documentationTypeIndicator", "kind": "optional", "type": "string", "description": "Type of documentation supporting the check: A-M indicate various image/paper combinations, Z=No image provided (X9.37 Field 9)" }, { "name": "cashLetterId", "kind": "optional", "type": "string", "description": "Unique eight-character identifier for this cash letter (X9.37 Field 10)" }, { "name": "originatorContactName", "kind": "optional", "type": "string", "description": "Name of the contact person at the institution creating the cash letter, up to 14 characters (X9.37 Field 11)" }, { "name": "originatorContactPhone", "kind": "optional", "type": "string", "description": "Ten-digit phone number for the originator contact (X9.37 Field 12)" }, { "name": "fedWorkType", "kind": "optional", "type": "string", "description": "Federal Reserve work type classification code, single character (X9.37 Field 13)" }, { "name": "userField", "kind": "optional", "type": "string", "description": "Field available for user-defined data per X9.37 standard, used at the discretion of participants" }, { "name": "reserved", "kind": "optional", "type": "string", "description": "Field reserved for future use per X9.37 specification, currently blank" } ] }, { "name": "bundle", "kind": "optional", "type": "object", "description": "X9.37 Bundle Header (Record Type 20) containing metadata about this bundle of check items within the cash letter", "children": [ { "name": "collectionTypeIndicator", "kind": "optional", "type": "string", "description": "Code identifying the type of collection: 00=Preliminary Forward, 01=Forward Presentment, 02=Same-Day Settlement, 03=Return, 04=Return Notification, 05=Preliminary Return Notification, 06=Final Return Notification, 20=No Detail, 99=Mixed collection types (X9.37 Field 2)" }, { "name": "destinationRoutingNumber", "kind": "optional", "type": "string", "description": "Nine-digit routing and transit number (TTTTAAAAC format) of the institution that receives and processes the cash letter (X9.37 Field 3)" }, { "name": "eceRoutingNumber", "kind": "optional", "type": "string", "description": "Nine-digit ECE (Exchange) institution's routing and transit number that creates the bundle header (X9.37 Field 4)" }, { "name": "businessDate", "kind": "optional", "type": "string", "description": "Business date of the cash letter in YYYYMMDD format (X9.37 Field 5)" }, { "name": "creationDate", "kind": "optional", "type": "string", "description": "Date the cash letter was created in Eastern Time zone, YYYYMMDD format (X9.37 Field 6)" }, { "name": "bundleId", "kind": "optional", "type": "string", "description": "Unique identifier for this bundle within the cash letter, up to 10 characters, assigned by the institution creating the bundle (X9.37 Field 7)" }, { "name": "sequenceNumber", "kind": "optional", "type": "string", "description": "Sequential number of this bundle within the cash letter, typically denoting relative position (X9.37 Field 8)" }, { "name": "cycleNumber", "kind": "optional", "type": "string", "description": "Processing cycle code under which the bundle is created, two characters assigned by the creating institution (X9.37 Field 9)" }, { "name": "returnLocationRoutingNumber", "kind": "optional", "type": "string", "description": "Nine-digit routing and transit number (TTTTAAAAC format) where returns, final return notifications, and preliminary return notifications are sent (X9.37 Field 3 in Addendum A)" }, { "name": "userField", "kind": "optional", "type": "string", "description": "Field available for user-defined data per X9.37 standard, used at the discretion of participants" }, { "name": "reserved", "kind": "optional", "type": "string", "description": "Field reserved for future use per X9.37 specification, currently blank" } ] }, { "name": "item", "kind": "optional", "type": "object", "description": "X9.37 Check Detail and related records containing the check item information including images and MICR data", "children": [ { "name": "checkDetail", "kind": "optional", "type": "object", "description": "X9.37 Check Detail Record (Type 25) containing MICR line data and processing indicators for the check item", "children": [ { "name": "auxiliaryOnUs", "kind": "optional", "type": "string", "description": "Code used on commercial checks at the discretion of the payor bank, typically for internal processing (X9.37 Field 2)" }, { "name": "externalProcessingCode", "kind": "optional", "type": "string", "description": "Code used for special purposes as authorized by X9, also known as Position 44 (X9.37 Field 3)" }, { "name": "payorRoutingNumber", "kind": "optional", "type": "string", "description": "Eight-digit routing number (TTTTAAAA format) identifying the institution by or through which the item is payable (X9.37 Field 4)" }, { "name": "payorCheckDigit", "kind": "optional", "type": "string", "description": "Check digit for the payor bank routing number to form a valid mod-checked nine-digit routing number (X9.37 Field 5)" }, { "name": "onUs", "kind": "optional", "type": "string", "description": "Data specified by the payor bank, typically includes account number, serial number, or transaction code, up to 20 characters (X9.37 Field 6)" }, { "name": "amount", "kind": "optional", "type": "string", "description": "The amount to be transferred, in cents. For example, 10001 = $100.01." }, { "name": "sequenceNumber", "kind": "optional", "type": "string", "description": "Sequential number of this bundle within the cash letter, typically denoting relative position (X9.37 Field 8)" }, { "name": "documentationTypeIndicator", "kind": "optional", "type": "string", "description": "Type of documentation supporting the check: A-M indicate various image/paper combinations, Z=No image provided (X9.37 Field 9)" }, { "name": "electronicReturnIndicator", "kind": "optional", "type": "string", "description": "Return Acceptance Indicator - indicates whether the creating institution will support electronic return processing, values 0-9 and A-F (X9.37 Field 10)" }, { "name": "micrValidIndicator", "kind": "optional", "type": "string", "description": "MICR read quality: 1=Good read, 2=Good read with missing field, 3=Read error encountered, 4=Missing field and read error (X9.37 Field 11)" }, { "name": "bofdIndicator", "kind": "optional", "type": "string", "description": "Bank of First Deposit indicator: Y=ECE is BOFD, N=ECE is not BOFD, U=Relationship undetermined (X9.37 Field 12)" }, { "name": "addendumCount", "kind": "optional", "type": "string", "description": "Number of Check Detail Record Addenda to follow, supports up to 99 addendum records (X9.37 Field 13)" }, { "name": "correctionIndicator", "kind": "optional", "type": "string", "description": "How the MICR line was repaired: 0=No repair, 1-3=Various repair methods, 4=Undetermined (X9.37 Field 14)" }, { "name": "archiveTypeIndicator", "kind": "optional", "type": "string", "description": "Type of archive supporting this Check Detail: A-I represent microfilm, image, paper, or combinations (X9.37 Field 15)" } ] }, { "name": "checkAddendumA", "kind": "optional", "type": "array", "description": "X9.37 Check Detail Addendum A (Record Type 26) containing Bank of First Deposit information and endorsement details" }, { "name": "checkAddendumB", "kind": "optional", "type": "array", "description": "X9.37 Check Detail Addendum B (Record Type 27) - Not supported by Federal Reserve Bank" }, { "name": "checkAddendumC", "kind": "optional", "type": "array", "description": "X9.37 Check Detail Addendum C (Record Type 28) containing endorsing bank information and return reason" }, { "name": "returnDetail", "kind": "optional", "type": "object", "description": "ReturnDetail", "children": [ { "name": "payorRoutingNumber", "kind": "optional", "type": "string", "description": "Eight-digit routing number (TTTTAAAA format) identifying the institution by or through which the item is payable (X9.37 Field 4)" }, { "name": "payorCheckDigit", "kind": "optional", "type": "string", "description": "Check digit for the payor bank routing number to form a valid mod-checked nine-digit routing number (X9.37 Field 5)" }, { "name": "onUs", "kind": "optional", "type": "string", "description": "Data specified by the payor bank, typically includes account number, serial number, or transaction code, up to 20 characters (X9.37 Field 6)" }, { "name": "amount", "kind": "optional", "type": "string", "description": "The amount to be transferred, in cents. For example, 10001 = $100.01." }, { "name": "returnReason", "kind": "optional", "type": "string", "description": "Code indicating the reason for non-payment or return of the check (X9.37 Addendum C Field 9)" }, { "name": "addendumCount", "kind": "optional", "type": "string", "description": "Number of Check Detail Record Addenda to follow, supports up to 99 addendum records (X9.37 Field 13)" }, { "name": "returnDocTypeIndicator", "kind": "optional", "type": "string", "description": "ReturnDocTypeIndicator" }, { "name": "forwardBundleDate", "kind": "optional", "type": "string", "description": "ForwardBundleDate" }, { "name": "eceSequenceNumber", "kind": "optional", "type": "string", "description": "Sequence number assigned by the ECE institution that creates the Check Detail, up to 15 characters (X9.37 Field 8)" }, { "name": "externalProcessingCode", "kind": "optional", "type": "string", "description": "Code used for special purposes as authorized by X9, also known as Position 44 (X9.37 Field 3)" }, { "name": "returnNotificationIndicator", "kind": "optional", "type": "string", "description": "ReturnNotificationIndicator" }, { "name": "returnArchiveTypeIndicator", "kind": "optional", "type": "string", "description": "ReturnArchiveTypeIndicator" }, { "name": "numberOfTimesReturned", "kind": "optional", "type": "string", "description": "NumberOfTimesReturned" }, { "name": "reserved", "kind": "optional", "type": "string", "description": "Field reserved for future use per X9.37 specification, currently blank" } ] }, { "name": "returnAddendumA", "kind": "optional", "type": "array", "description": "X9.37 Return Detail Addendum A (Record Type 32) containing Bank of First Deposit information for returned items" }, { "name": "returnAddendumB", "kind": "optional", "type": "object", "description": "ReturnAddendumB", "children": [ { "name": "payorBankName", "kind": "optional", "type": "string", "description": "Short name (up to 18 characters) of the institution by or through which the item is payable (X9.37 Return Addendum B Field 2)" }, { "name": "auxiliaryOnUs", "kind": "optional", "type": "string", "description": "Code used on commercial checks at the discretion of the payor bank, typically for internal processing (X9.37 Field 2)" }, { "name": "payorBankSequenceNumber", "kind": "optional", "type": "string", "description": "Number that identifies the item at the payor bank, up to 15 characters (X9.37 Return Addendum B Field 4)" }, { "name": "payorBankBusinessDate", "kind": "optional", "type": "string", "description": "Date the payor bank processed the Return Record in YYYYMMDD format (X9.37 Return Addendum B Field 5)" }, { "name": "payorAccountName", "kind": "optional", "type": "string", "description": "Account name from payor bank records, up to 22 characters (X9.37 Return Addendum B Field 6)" } ] }, { "name": "returnAddendumC", "kind": "optional", "type": "object", "description": "X9.37 Return Detail Addendum C (Record Type 34) containing endorsement and deposit information" }, { "name": "returnAddendumD", "kind": "optional", "type": "array", "description": "X9.37 Return Detail Addendum D (Record Type 35) containing additional return reason information" }, { "name": "images", "kind": "optional", "type": "array", "description": "Images" } ] } ] } ], "description": "", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "hasTryItOut": false, "autoGeneratedAnchorSlug": "endpoint-v1paymentsidextended", "legacyHash": "315ZOzr02aCRFE1R9h0zN" } ``` :::