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

Check payment ID. This ID is in GUID format.

Number of the account receiving the check

accountNumber

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.

referenceId

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)

paymentType

Type of check being dealt with. There are several check types:
- Standard
- OnUs
- Treasury
- MoneyOrder
- FedReserveBank
- FedHomeLoan
- StateLocalGovt
- Certified
- Unknown

checkType

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.)

direction 

Status of the check payment. There are several possible payment statuses:
- Created
- Pending
- Hold
- Batched
- Processing
- Completed
- Rejected
- Canceled

status

Source of the payment request:
- Api
- PartnerPortal
- OpsPortal
- File
- System
- Lockbox

source

Account posting status:
- Pending
- Posted
- Failed
- Canceled
- Authorized
- Authorizing

posting

Rejected because:
- ImageAnalysisFailure
- PostingException
- AmountMismatch
- MaxItemAmountExceeded
- MaxDepositAmountExceeded
- MaxItemsPerDayExceeded
- Duplicate
- PayerRoutingNumberInvalid
- PayerAccountNumberInvalid
- CheckNumberInvalid
- AccountNotFound
- DepositsNotEnabled
- InvalidAccountType
- NotSpecified

rejectionReason

If Positive Pay is enabled, the positive pay status of the check:
- Pending
- Authorized
- Unauthorized
- Disabled

positivePayResult

If Positive Pay is enabled, ID of the positive pay record associated with the payment

positivePayMatchId

Code related to the Cross River system transaction tied to the payment. Any value other than “OK” indicates a rejection.

postingCode

ID for the batch received from the Cross River lockbox vendor

clientBatchId

Sequence number of the payment inside the batch received from the Cross River lockbox vendor

clientBatchSequence

ID of the distribution that the check was included in

fedBatchId

Sequence number of the payment inside the distribution

fedBatchSequence

Internal Cross River unique ID for the transaction

coreTransactionId

Unique identifier for the memo post. This ID is in GUID format.

memoPostId

The original payment ID, when a check has been returned or redeposited

originalPaymentId

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.

customerId

The payer’s routing number (printed on the check)

payerRoutingNumber

The payer’s account number (printed on the check)

payerAccountNumber

Name written on the pay to the order of line of the check

payeeName

The serial number that appears on the check

checkNumber

The routing number of the bank where the check was first deposited

bofdRoutingNumber

sequenceNumber

amount

Currency of the check. For example, USD (US dollars)

currency

The magnetic ink character recognition line, consisting of the routing number, account number and check number

micr

The check amount recognized from the check image via OCR

recognizedAmount

True if the check has passed the Fed’s image quality assurance standards, otherwise false

iqaPassed

The return code indicates why the check was returned. There are several return codes.

returnCode

True if the check image file includes the front of the check. Otherwise false.

hasFrontImage

True if the check image file includes the back of the check. Otherwise false.

hasBackImage

True if the check was deposited before. Otherwise false.

isRedeposit

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

policy 

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.

schedule

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]

createdAt

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]

canceledAt

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]

rejectedAt

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]

processedAt

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]

completedAt

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]

postedAt

True if the check was returned. Otherwise false.

wasReturned

purpose

Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.

clientIdentifier

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.

depositBusinessDate

ID of the lockbox service receiving the paper checks and sending them via ICL to Cross River

lockboxVendorId

ID in GUID format of your specific product type on which the Cross River account is based. Provided by Cross River. 

productId

Your unique ID in the Cross River system. This ID is in GUID format.

partnerId

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]

lastModifiedAt

Deposit a check with images using POST /checks/v1/payments to deposit into a Cross River account.

Deposit check

Print check payment

List check payments

Get payment details

Get extended check data

Cancel deposit

View check

Image analysis

Authorize check

Revoke authorization

Initiate check return

Simulate inbound payment

Simulate inbound check return

APIs

Webhook events: Checks

Request and response codes: Checks

Error codes: checks

Checks

Electronic Commerce Indicator. A code that signifies the type of electronic commerce transaction during payment processing. It distinguishes between transaction categories, particularly in transactions where the card is not physically present. 

Cardholder Authentication Verification Value. A cryptographic token generated by the card issuer’s Access Control Server (ACS) during a 3D Secure (3DS) authentication process.

CAVV

Strong Customer Authentication. This is a regulatory requirement that mandates multi-factor authentication for electronic payments to enhance security and reduce fraud.

Virtual Private Cloud. A global virtual network that spans all regions and lets you isolate your resources within projects.

Card Verification Code. A three-digit security codes on Mastercard payment cards used to verify cardholder possession during online or phone transactions.

Card Verification Value. A three-digit security codes on VISA payment cards used to verify cardholder possession during online or phone transactions.

Payment Card Industry Data Security Standard. Created to improve and streamline the security controls organizations use when handling cardholder data and reduce credit card fraud.

PCI_DSS

Payment Services Directive 2 is a EU regulation that aims to enhance the safety and security of payment services and promote innovation and competition in the market.

PSD2

The Federal Reserve Banks use the X9 industry standard to safely exchange check data and digital check images with other banks. This electronic format allows banks to process and transfer check deposits quickly without needing to mail the origin

X9_check_standard

This is an international electronic money transfer for friends and family to send money to those across borders quickly and easily.

remittance_transfer

This is any entity that regularly sends money from consumers to businesses and individuals in other countries. This includes banks and financial service institutions that conduct remittance transfers as part of their normal business operations.

remittance_transfer_provider

The net transfer of funds between the issuer and acquirer, facilitated by the card network, to fulfill the financial obligations of cleared transactions (typically T+1).​

Settlement_in_Cards

An issuing processor authorizes or declines card transactions on behalf of the issuing bank. Cross River has an in-house card issuing processing engine called P1. ​

Issuing_Processor

Fee paid between banks for acceptance of card-based transactions, facilitated via the card networks.​

Interchange

Process by which the merchant's final transaction details are submitted through the card network to the issuer.​

Clearing

The Merchant’s bank in the Four Party Model (cardholder, merchant, acquiring bank, network, issuing bank). Charges MDR to Merchant, pays Interchange card networks.

Acquiring_Bank

Me2Me payments involve a person or entity transferring funds between two accounts that they own.

Me2Me

Wallet defunding refers to the process of moving money from digital wallets back to bank accounts.

Wallet_Defunding

A descriptive reference used to define a range of accounts not held in Cross River. The prefix then is tied to a partners FBO account.

external_account_prefix

Three-Domain Secure is a security protocol designed to enhance the security of online credit and debit card transactions, helping to prevent fraud and unauthorized use.

Primary Account Number. A unique identifier, typically 14 to 19 digits, found on credit, debit, and other payment cards that indicates the card issuer and the individual cardholder.

SAS Anti-Money Laundering. This system helps institutions detect and prevent illicit activity while maintaining regulatory compliance, using advanced detection, AI, and machine learning to strengthen monitoring and protect against financial crime.

SAS_AML

ClaveBancaria Estandarizada is a standardized banking code used in Mexico to identify bank accounts. It consists of 18 digits that include the bank code, branch location, and account number. 

CLABE

Accounting for Financial Liabilities. Refers to receipts or payments from personal non-resident bank accounts. Helps financial institutions identify the nature of the transactions being processed, ensuring accurate reporting and compliance.

Accounting for Financial Assets. Refers to receipts or payments from personal resident bank accounts or deposits. Helps financial institutions identify the nature of the transactions being processed, ensuring accurate reporting and compliance.


Customer Identification File. A digital record that contains comprehensive details about a bank’s customers. It serves as a centralized repository for essential information related to an individual's banking relationship.

Fair banking is the principle and practice of providing equal and non-discriminatory access to financial services, ensuring that decisions by banks are based on objective risk rather than political, religious, or ideological affiliations.

Fair_Banking

Fair_Lending

Account Funding Transaction.  Pull funds from a debit card for specific purposes. Use an AFT to fund a wallet or prepaid card, or to initiate a person-to-person (P2P) transfer through the card network rails. AFTs are not allowed for purchases.

A 32-character hexadecimal string with hyphens, such as 123e4567-e89b-12d3-a456-426655440000 used as a unique identified. Sometimes called a UUID.

GUID

Know Your Business processes verify legitimacy business entities and their ownership structures to prevent financial crime and comply with regulations. KYB requires information including company registrations and operational activities. See also KYC.

Know Your Customer processes verify the identity of an individual customer to prevent financial crime and comply with regulations. KYC uses personal details and identity documents for this verification.

A GUID assigned to you by Cross River. This ID is required for some API calls.

Partner_ID

The automated lending platform from Cross River that includes services such as Preapproval, Oversight, Arix Origination and Funding, Selling, and Hooks.

Lending

Information that can be used to distinguish or trace an individual’s identity, either alone or when combined with other information that is linked or linkable to a specific individual. Also known as PII.

Personally_Identifiable_Information

These are contracts for monetary assets that can be purchased, traded, created, modified, or settled for. In terms of contracts, there is a contractual obligation between involved parties during a financial instrument transaction.

financial_instrument

Interest Rate Cards are pre-configured interest rate profiles that can be assigned to specific accounts on demand.

rate_card

A financial institution holding a principal license with a Card Network has the right to issue cards itself and sponsor other institutions (fintechs) to issue on its behalf (BIN sponsorship). Affiliate/Associate members cannot offer BIN sponsorship.

Principal_member

A 6 or 8 digit number assigned by the card networks for card issuing and functions as the first 6 or 8 digits on the card itself. The BIN identifies the bank that is responsible for issuing the program and handling daily settlement with the Network.

Card_BIN

A solution that allows partners to offer card solutions without requiring a direct relationship with the card networks. The bank acts as an intermediary while allowing partners to use its bank identification numbers (BIN). 

BIN_sponsorship

Politically Exposed Person is an individual who holds a prominent public position, or has done so in the recent past and is subject to a higher level of scrutiny due to an increased risk of involvement in bribery, corruption, and money laundering.

Office of Foreign Assets Control. Part of the US Department of the Treasury that administers and enforces economic and trade sanctions based on US foreign policy and national security goals.

OFAC

Move funds internally between accounts. The transfer requires both a debit and credit account and can be either a master account or sub-ledger, or any combination of the two.  Can be made via API calls or for non-API Partners on the COS Explorer.

book_transfer

This is where the financial institution verifies the member has the funds needed before they are transferred to the receiver.

Good_Funds_Model

An instant payment service developed and operated by the Federal Reserve for financial institutions in the United States, which allows individuals and businesses to send and receive money.

FedNow

A payment processing network used to send money electronically between banks in the US. Available year round, it transfers funds between 2 banks account instantaneously. Processes on bank holidays and weekend and after business hours.

A merchant category code (MCC) is a four-digit number used for retail financial services to classify a business by the types of goods or services it provides. Codes are specified by the ISO 18245 standard.

Card Acceptor ID. An internal identifier assigned to your business by your Acquirer when creating the merchant account used for financial processing.

CAID

Business Application Identifier, used by merchants in card payments

Deposit check

Relevant webhooks

API reference