Deposit check

Relevant webhooks

For this endpoint be sure you have registered for these webhooks:

Check.Payment.Sent

Check.Payment.Received

Check.Payment.Rejected

API reference

Sends the Cross River system information needed to deposit a check into a Cross River account using the API. This information includes images of both the front and the back of the check. You submit these images after converting each one to a Base64-encoded value.

Endpoint: /checks/v1/payments

POST

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

Body Parameters

accountNumberstringrequired
Description
Number of the Cross River account receiving the check
amountintegerrequired
Description
Money amount that appears on the check
frontImagestringrequired
Description
The base64-encoded image of the front of the check, no larger than 1 MB
backImagestringrequired
Description
The base64-encoded image of the back of the check, no larger than 1 MB
purposestring
Description
Purpose of the deposited check 50 characters maximum
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. 50 characters maximum
isRedepositboolean
Description
True if the check was deposited before. Otherwise false.

Response

idstring
Description
Check payment ID. This ID is in GUID format.
accountNumberstring
Description
Number of the account receiving the check
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
direction string
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
Account 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.
policy string
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]

curl

curl --location 'https://sandbox.crbcos.com/checks/v1/payments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "accountNumber": "2640511503",
  "amount": 10000,
  "frontImage": "/9j/4QuqRXhpZgAATU0AKgA...",
  "backImage": "/9j/4REyRXhpZgAATU0AKgAA...",
  "isRedeposit": false,
  "purpose": "SKIP_IQA"
}'

nodejs

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

var options = {
  'method': 'POST',
  'hostname': 'sandbox.crbcos.com',
  'path': '/checks/v1/payments',
  'headers': {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  '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);
  });
});

var postData = JSON.stringify({
  "accountNumber": "2640511503",
  "amount": 10000,
  "frontImage": "/9j/4QuqRXhpZgAATU0AKgA...",
  "backImage": "/9j/4REyRXhpZgAATU0AKgAA...",
  "isRedeposit": false,
  "purpose": "SKIP_IQA"
});

req.write(postData);

req.end();

python

import http.client
import json

conn = http.client.HTTPSConnection("sandbox.crbcos.com")
payload = json.dumps({
  "accountNumber": "2640511503",
  "amount": 10000,
  "frontImage": "/9j/4QuqRXhpZgAATU0AKgA...",
  "backImage": "/9j/4REyRXhpZgAATU0AKgAA...",
  "isRedeposit": False,
  "purpose": "SKIP_IQA"
})
headers = {
  'Authorization': 'Bearer <token>',
  'Content-Type': 'application/json'
}
conn.request("POST", "/checks/v1/payments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

ruby

require "uri"
require "json"
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::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "accountNumber": "2640511503",
  "amount": 10000,
  "frontImage": "/9j/4QuqRXhpZgAATU0AKgA...",
  "backImage": "/9j/4REyRXhpZgAATU0AKgAA...",
  "isRedeposit": false,
  "purpose": "SKIP_IQA"
})

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

package main

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

func main() {

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

  payload := strings.NewReader(`{
  "accountNumber": "2640511503",
  "amount": 10000,
  "frontImage": "/9j/4QuqRXhpZgAATU0AKgA...",
  "backImage": "/9j/4REyRXhpZgAATU0AKgAA...",
  "isRedeposit": false,
  "purpose": "SKIP_IQA"
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  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

{
    "id": "18619219-ccbb-45a6-a068-b30c008f7b47",
    "accountNumber": "2640511503",
    "referenceId": "C181DC3259D7",
    "paymentType": "Forward",
    "checkType": "Standard",
    "direction": "Outbound",
    "status": "Created",
    "source": "Api",
    "posting": "Pending",
    "postingCode": "OK",
    "coreTransactionId": "31746634-977b-461f-9899-b30c008f7b47",
    "memoPostId": "51b24aa9-1cdc-4d82-9ddb-b30c008f7b47",
    "originalPaymentId": "18619219-ccbb-45a6-a068-b30c008f7b47",
    "customerId": "53c34cf0-4cd2-4768-937b-b30000dffdca",
    "payerRoutingNumber": "",
    "payerAccountNumber": "",
    "payeeName": "",
    "checkNumber": "",
    "bofdRoutingNumber": "021214891",
    "sequenceNumber": "2203615981",
    "amount": 10000,
    "currency": "usd",
    "recognizedAmount": 0,
    "iqaPassed": false,
    "hasFrontImage": true,
    "hasBackImage": true,
    "isRedeposit": false,
    "policy": "Standard",
    "schedule": [
        0,
        10000
    ],
    "createdAt": "2025-06-30T04:42:24.0202774-04:00",
    "wasReturned": false,
    "purpose": "SKIP_IQA",
    "depositBusinessDate": "250701",
    "productId": "83bed086-8182-4151-a1e3-af5b01362783",
    "partnerId": "cd9c12f4-7691-424a-b38b-af5b0134c611",
    "lastModifiedAt": "2025-06-30T04:42:24.0515279-04:00"
}

400

{
    "errors": [
        {
            "code": 2301,
            "message": "Deposits not allowed for account type"
        }
    ]
}