List check payments

API reference

Returns details about all check payments of a single partner. The results object repeats for each check.

GET calls

Use query parameters to filter the results.

Calls that return a list send it one page at a time. Use pageNumber and pageSize to choose a page. For details, see pagination

Endpoint: /checks/v1/payments

GET

https://sandbox.crbcos.com/checks/v1/payments

Query Parameters

originalPaymentIdstring
Description
Payment ID returned when the check was originally deposited
referenceIdstring
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.
directionstring
Description
Check direction: - Inbound (A check drawn from a COS account, deposited at another bank. See Deposit.) - Outbound (A check deposited into a COS account, drawn from an account at another bank. See Withdrawal.)
statusstring
Description
Status of the check payment. There are several possible payment statuses: - Created - Pending - Hold - Batched - Processing - Completed - Rejected - Canceled
paymentTypestring
Description
Indicates whether the check has been presented for payment or has been returned for some reason: - Forward (a check presented for payment, to be sent to the payer bank) - Return (A previous forward item that the payer bank returned)
checkTypestring
Description
Type of check being dealt with. There are several check types: - Standard - OnUs - Treasury - MoneyOrder - FedReserveBank - FedHomeLoan - StateLocalGovt - Certified - Unknown
postingstring
Description
Account posting status: - Pending - Posted - Failed - Canceled - Authorized - Authorizing
postingCodestring
Description
Code related to the Cross River system transaction tied to the payment. Any value other than “OK” indicates a rejection.
minAmountinteger
Description
Minimum dollar amount of the check to look for, in positive integral cents. For example, $1.00 appears as 100.
maxAmountinteger
Description
Maximum dollar amount of the check to look for, in positive integral cents. For example, $1.00 appears as 100.
accountNumberstring
Description
Number of the Cross River account the check payments posted to
sequenceNumberstring
Description
The position of the check in a bundle or batch of checks, found in the ICL file as part of the CheckDetail record
checkNumberstring
Description
The serial number printed on the check
fromstring
Description
Earliest payment to look for. Use format yyyy-mm-dd
tostring
Description
Latest payment to look for. Use format yyyy-mm-dd
partnerIdstring
Description
Your unique ID in the Cross River system. This ID is in GUID format.
productIdstring
Description
ID in GUID format of your specific product type on which the account is based. Provided by Cross River. A query by product ID returns all payments for all accounts created using that product.
wasReturnedboolean
Description
True if the check was returned. Otherwise false. A query on this value will return either payments or payment returns, not both.
isRedepositboolean
Description
True if the check was deposited before. Otherwise false.
clientIdentifierstring
Description
Search on the value you added as your own unique identifying string to a payment call or COS record
depositBusinessDatestring
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.
pageNumberinteger
Description
Page to return, starting at 1. Default is 1. See Pagination.
pageSizeinteger
Description
Number of records per page. Default is 10 and maximum is 50. See Pagination.

Response

resultsobject
Description
Array of check payment objects. Each object has the following fields.
- idstring
  Description
  Check payment ID. This ID is in GUID format.
- accountNumberstring
  Description
  Number of the account the check is posting to
- referenceIdstring
  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.
- paymentTypestring
  Description
  The check paymentType indicates whether the check has been presented for payment or has been returned for some reason: - Forward (a check presented for payment, to be sent to the payer bank) - Return (A previous forward item that the payer bank returned)
- checkTypestring
  Description
  Type of check being dealt with. There are several check types: - Standard - OnUs - Treasury - MoneyOrder - FedReserveBank - FedHomeLoan - StateLocalGovt - Certified - Unknown
- directionstring
  Description
  Check direction: - Inbound (A check drawn from a COS account, deposited at another bank. See Deposit.) - Outbound (A check deposited into a COS account, drawn from an account at another bank. See Withdrawal.)
- statusstring
  Description
  Status of the check payment. There are several possible payment statuses: - Created - Pending - Hold - Batched - Processing - Completed - Rejected - Canceled
- sourcestring
  Description
  Source of the payment request: - Api - PartnerPortal - OpsPortal - File - System - Lockbox
- postingstring
  Description
  Posting status: - Pending - Posted - Failed - Canceled - Authorized - Authorizing
- rejectionReasonstring
  Description
  Rejected because: - ImageAnalysisFailure - PostingException - AmountMismatch - MaxItemAmountExceeded - MaxDepositAmountExceeded - MaxItemsPerDayExceeded - Duplicate - PayerRoutingNumberInvalid - PayerAccountNumberInvalid - CheckNumberInvalid - AccountNotFound - DepositsNotEnabled - InvalidAccountType - NotSpecified
- positivePayResultstring
  Description
  If Positive Pay is enabled, the positive pay status of the check: - Pending - Authorized - Unauthorized - Disabled
- positivePayMatchIdstring
  Description
  If Positive Pay is enabled, ID of the positive pay record associated with the payment
- postingCodestring
  Description
  Code related to the Cross River system transaction tied to the payment. Any value other than “OK” indicates a rejection.
- clientBatchIdstring
  Description
  ID for the batch received from the Cross River lockbox vendor
- clientBatchSequenceinteger
  Description
  Sequence number of the payment inside the batch received from the Cross River lockbox vendor
- fedBatchIdstring
  Description
  ID of the distribution that the check was included in
- fedBatchSequenceinteger
  Description
  Sequence number of the payment inside the distribution
- coreTransactionIdstring
  Description
  Internal Cross River unique ID for the transaction
- memoPostIdstring
  Description
  Unique identifier for the memo post. This ID is in GUID format.
- originalPaymentIdstring
  Description
  The original payment ID, when a check has been returned or redeposited
- customerIdstring
  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. The ID is in GUID format.
- payerRoutingNumberstring
  Description
  The payer’s routing number (printed on the check)
- payerAccountNumberstring
  Description
  The payer’s account number (printed on the check)
- payeeNamestring
  Description
  Name written on the pay to the order of line of the check
- checkNumberstring
  Description
  The serial number that appears on the check
- bofdRoutingNumberstring
  Description
  The routing number of the bank where the check was first deposited
- sequenceNumberstring
  Description
  The check sequence number
- amountinteger
  Description
  Money amount that appears on the check
- currencystring
  Description
  Currency of the check. For example, USD (US dollars)
- micrstring
  Description
  The magnetic ink character recognition line, consisting of the routing number, account number and check number
- recognizedAmountinteger
  Description
  The check amount recognized from the check image via OCR
- iqaPassedboolean
  Description
  True if the check has passed the Fed’s image quality assurance standards, otherwise false
- returnCodestring
  Description
  The return code indicates why the check was returned. There are several return codes.
- hasFrontImageboolean
  Description
  True if the check image file includes the front of the check. Otherwise false.
- hasBackImageboolean
  Description
  True if the check image file includes the back of the check. Otherwise false.
- isRedepositboolean
  Description
  True if the check was deposited before. Otherwise false.
- policystring
  Description
  The current availability policy type assigned to the deposit, defining the schedule for making funds available: - Standard - NewAccount - LargeDeposits - RedepositedCheck - RepeatedOverdrafts - OnUs - RCNoticeOfUnpaidReturn - RCSuspectFraud - RCFundingAccountOverdrafts - RCUnverifiedEndorsement - RCInconsistentInformation - RCErasuresOrAlterations - RCOutOfDateRoutingNumber - RCPostDatedOrStaleDate - RCPayingBankNotPaidIndication - RCLostOrDamaged - FiveDay - EmergencyConditions
- schedulearray
  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.
- createdAtstring
  Description
  Date and time the check payment was created. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]
- canceledAtstring
  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]
- rejectedAtstring
  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]
- processedAtstring
  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]
- completedAtstring
  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]
- postedAtstring
  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]
- wasReturnedboolean
  Description
  True if the check was returned. Otherwise false.
- purposestring
  Description
  Purpose of the deposited check
- clientIdentifierstring
  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.
- depositBusinessDatestring
  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.
- lockboxVendorIdstring
  Description
  ID of the lockbox service receiving the paper checks and sending them via ICL to Cross River
- productIdstring
  Description
  ID in GUID format of your specific product type on which the Cross River account is based. Provided by Cross River.
- partnerIdstring
  Description
  Your unique ID in the Cross River system. This ID is in GUID format.
- lastModifiedAtstring
  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]
pageNumberinteger
Description
Page returned
pageSizeinteger
Description
Number of records on this page
hasPreviousPageboolean
Description
True if pageNumber is greater than 1
hasNextPageboolean
Description
True if there is at least one more page

curl

curl --location 'https://sandbox.crbcos.com/checks/v1/payments' \
--header 'Authorization: Bearer <token>'

nodejs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'sandbox.crbcos.com',
  'path': '/checks/v1/payments',
  'headers': {
    'Authorization': 'Bearer <token>'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

req.end();

python

import requests

url = "https://sandbox.crbcos.com/checks/v1/payments"

payload = {}
headers = {
  'Authorization': 'Bearer <token>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://sandbox.crbcos.com/checks/v1/payments")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer <token>"

response = https.request(request)
puts response.read_body

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://sandbox.crbcos.com/checks/v1/payments"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

200

{
    "results": [
        {
            "id": "3366874c-b887-4532-aec7-b48c006d4d1f",
            "accountNumber": "2203250853",
            "referenceId": "C200R1684TDQ",
            "paymentType": "Return",
            "checkType": "Standard",
            "direction": "Inbound",
            "status": "Completed",
            "source": "Api",
            "posting": "Posted",
            "postingCode": "OK",
            "fedBatchId": "0cfb50f6-afdd-4033-a1c2-b48c006d4d1f",
            "fedBatchSequence": 0,
            "coreTransactionId": "7153b673-bf50-4b9b-b097-b48c006d4d1f",
            "originalPaymentId": "3d70fc63-672e-4c3b-9e66-b48700b5db14",
            "customerId": "861261af-1251-49e8-966f-b2ff00d627bd",
            "payerRoutingNumber": "314074269",
            "payerAccountNumber": "28293886",
            "payeeName": "",
            "checkNumber": "1237",
            "bofdRoutingNumber": "021214891",
            "sequenceNumber": "3918624417",
            "amount": 10000,
            "currency": "usd",
            "recognizedAmount": 0,
            "iqaPassed": false,
            "returnCode": "A",
            "hasFrontImage": true,
            "hasBackImage": true,
            "isRedeposit": false,
            "policy": "Standard",
            "schedule": [],
            "createdAt": "2026-07-19T02:37:57.223-04:00",
            "processedAt": "2026-07-19T02:37:57.587-04:00",
            "completedAt": "2026-07-19T02:37:57.743-04:00",
            "postedAt": "2026-07-19T02:37:57.743-04:00",
            "wasReturned": false,
            "purpose": "TESTING",
            "decisionRequired": false,
            "wasDecisioned": false,
            "productId": "83bed086-8182-4151-a1e3-af5b01362783",
            "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
            "lastModifiedAt": "2026-07-19T02:37:57.7438976-04:00"
        },
        {
            "id": "ffacc406-7d79-4051-b20d-b48c0085b262",
            "accountNumber": "2846220461",
            "referenceId": "C200859Z8JXH",
            "paymentType": "Return",
            "checkType": "Unknown",
            "direction": "Outbound",
            "status": "Pending",
            "source": "Api",
            "posting": "Authorized",
            "postingCode": "OK",
            "coreTransactionId": "ad3e3ea6-6521-4fc6-9b7c-b48c0085b262",
            "memoPostId": "7a18b8c6-1d21-41eb-b2b2-b48c0085b262",
            "originalPaymentId": "2100980b-4419-4a42-bc4c-b449006b84ec",
            "customerId": "05106466-9144-4f3f-8fb1-b345005d18ba",
            "payerRoutingNumber": "021214891",
            "payerAccountNumber": "2846220461",
            "payeeName": "string",
            "checkNumber": "2846220461",
            "bofdRoutingNumber": "021214891",
            "sequenceNumber": "6121648120",
            "amount": 4400,
            "currency": "usd",
            "recognizedAmount": 0,
            "iqaPassed": false,
            "returnCode": "I",
            "hasFrontImage": true,
            "hasBackImage": true,
            "isRedeposit": false,
            "policy": "Standard",
            "schedule": [],
            "createdAt": "2026-07-19T04:06:46.513-04:00",
            "wasReturned": false,
            "decisionRequired": false,
            "wasDecisioned": false,
            "productId": "83bed086-8182-4151-a1e3-af5b01362783",
            "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
            "lastModifiedAt": "2026-07-19T04:06:46.8913621-04:00"
        },
        {
            "id": "b150ebbf-72bd-478a-ae2e-b48c008909ce",
            "accountNumber": "2846220461",
            "referenceId": "C2002C520504",
            "paymentType": "Forward",
            "checkType": "Unknown",
            "direction": "Inbound",
            "status": "Processing",
            "source": "Api",
            "posting": "Failed",
            "postingCode": "NSF",
            "fedBatchId": "95af5b77-ff7c-4a13-b8c3-b48c008909ce",
            "fedBatchSequence": 0,
            "coreTransactionId": "a1940dd4-ec14-47b2-8c4e-b48c008909ce",
            "originalPaymentId": "b150ebbf-72bd-478a-ae2e-b48c008909ce",
            "customerId": "05106466-9144-4f3f-8fb1-b345005d18ba",
            "payerRoutingNumber": "021214891",
            "payerAccountNumber": "2846220461",
            "payeeName": "string",
            "checkNumber": "1032357",
            "bofdRoutingNumber": "061000146",
            "sequenceNumber": "4536586199",
            "amount": 44000,
            "currency": "usd",
            "recognizedAmount": 0,
            "iqaPassed": false,
            "hasFrontImage": true,
            "hasBackImage": true,
            "isRedeposit": false,
            "policy": "Standard",
            "schedule": [],
            "createdAt": "2026-07-19T04:18:56.473-04:00",
            "processedAt": "2026-07-19T04:18:56.69-04:00",
            "wasReturned": false,
            "purpose": "TESTING",
            "depositBusinessDate": "260720",
            "decisionRequired": false,
            "wasDecisioned": false,
            "productId": "83bed086-8182-4151-a1e3-af5b01362783",
            "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
            "lastModifiedAt": "2026-07-19T04:18:56.9721824-04:00"
        },
        {
            "id": "3ce66d18-2669-4c26-bb7d-b48c0089da8b",
            "accountNumber": "2846220461",
            "referenceId": "C200WD82L14A",
            "paymentType": "Forward",
            "checkType": "Unknown",
            "direction": "Inbound",
            "status": "Completed",
            "source": "Api",
            "posting": "Posted",
            "postingCode": "OK",
            "fedBatchId": "bc4058fe-74ee-47a9-8cde-b48c0089da8b",
            "fedBatchSequence": 0,
            "coreTransactionId": "01b5ba15-df91-4b0b-a288-b48c0089da8b",
            "originalPaymentId": "3ce66d18-2669-4c26-bb7d-b48c0089da8b",
            "customerId": "05106466-9144-4f3f-8fb1-b345005d18ba",
            "payerRoutingNumber": "021214891",
            "payerAccountNumber": "2846220461",
            "payeeName": "string",
            "checkNumber": "1032357",
            "bofdRoutingNumber": "061000146",
            "sequenceNumber": "3650080823",
            "amount": 4500,
            "currency": "usd",
            "recognizedAmount": 0,
            "iqaPassed": false,
            "hasFrontImage": true,
            "hasBackImage": true,
            "isRedeposit": false,
            "policy": "Standard",
            "schedule": [],
            "createdAt": "2026-07-19T04:21:54.593-04:00",
            "processedAt": "2026-07-19T04:21:54.663-04:00",
            "completedAt": "2026-07-19T04:21:54.717-04:00",
            "postedAt": "2026-07-19T04:21:54.717-04:00",
            "wasReturned": true,
            "purpose": "TESTING",
            "depositBusinessDate": "260720",
            "decisionRequired": false,
            "wasDecisioned": false,
            "productId": "83bed086-8182-4151-a1e3-af5b01362783",
            "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
            "lastModifiedAt": "2026-07-19T04:38:01.0965045-04:00"
        },
        {
            "id": "f6a270e5-da26-4325-88d4-b48c008e4727",
            "accountNumber": "2846220461",
            "referenceId": "C200I8164R2N",
            "paymentType": "Return",
            "checkType": "Unknown",
            "direction": "Outbound",
            "status": "Pending",
            "source": "Api",
            "posting": "Authorized",
            "postingCode": "OK",
            "coreTransactionId": "bde5ef07-f9e3-412c-9bd1-b48c008e4727",
            "memoPostId": "a1433756-8cb3-4e11-a79a-b48c008e4727",
            "originalPaymentId": "3ce66d18-2669-4c26-bb7d-b48c0089da8b",
            "customerId": "05106466-9144-4f3f-8fb1-b345005d18ba",
            "payerRoutingNumber": "021214891",
            "payerAccountNumber": "2846220461",
            "payeeName": "string",
            "checkNumber": "2846220461",
            "bofdRoutingNumber": "021214891",
            "sequenceNumber": "3650080823",
            "amount": 4500,
            "currency": "usd",
            "recognizedAmount": 0,
            "iqaPassed": false,
            "returnCode": "I",
            "hasFrontImage": true,
            "hasBackImage": true,
            "isRedeposit": false,
            "policy": "Standard",
            "schedule": [],
            "createdAt": "2026-07-19T04:38:01.09-04:00",
            "wasReturned": false,
            "decisionRequired": false,
            "wasDecisioned": false,
            "productId": "83bed086-8182-4151-a1e3-af5b01362783",
            "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
            "lastModifiedAt": "2026-07-19T04:38:01.2612968-04:00"
        }
    ],
    "pageNumber": 1,
    "pageSize": 5,
    "hasPreviousPage": false,
    "hasNextPage": false
}