Cancels a specific check deposit according to its payment ID. There are times when you need to cancel a check deposit. For example, to prevent a loss on an account where check kiting activity has been identified. You can only cancel a check if the payment hasn't been processed yet.

Endpoint: /checks/v1/payments/{id}/cancel

Unique ID of the check payment ID to be cancelled, in GUID format

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 deposit or has been returned for some reason:

- Forward (a check presented for deposit, 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

Posting status:
- Pending
- Posted
- Failed
- Canceled
- Authorized
- Authorizing

posting

- 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 account is based. Provided by Cross River. In this case, it's the product ID of the payee account.

productId

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

lastModifiedAt

Deposit check

Cancel deposit

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

The automated loan validation and funding software from Cross River

Arix

Mobile Deposit Capture is the process of submitting a check electronically using a smartphone

Input Message Accountability Data. A unique number given to each FedWire payment when using the Federal Reserver Bank Service and can be used to investigate and track wire transfers.

IMAD

Notification of Change.  The purpose of an NOC is to identify and communicate incorrect information within an ACH entry, such as account numbers or transit and routing number. Sent by a RDFI to the ODFI and the Originator via their ACH Operator.

A global financial messaging standard for electronic payments. It enhances interoperability across financial systems, improves payment processing efficiency and supports compliance by providing detailed transaction information.

ISO20022

A SWIFT Code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. These codes are used when transferring money between banks, particularly for international wire transfers.

SWIFT

Receiving Depository Financial Institution. All ODFIs must also agree to act as an RDFI to receive ACH payments. An RDFI receives entries directly or indirectly from its ACH Operator for debit or credit to the accounts of its customers.

RDFI

Originating Depository Financial Institution. It has the authority to initiate ACH transactions on behalf of its customers. ODFIs ensure compliance with regulatory standards and securely transmit payment instructions to the ACH network

ODFI

 National Automated Clearing House Association. Nacha governs the ACH Network, the payment system that drives Direct Deposits and Direct Payments with the capability to reach all U.S. bank and credit union accounts

Nacha

International ACH Transaction. A Nacha SEC code.

A uniquely configured financial product you offer your customers. For example, a debit card or a savings account, configured according to your needs and specifications, are product types.

product_type

Bank Identification Number. A unique identifier used in payment card transactions.

COS_Explorer

relationshipmanager

Cross River guides provide details about our products

guide

var_miha

new_var_2

new_mih_var

mih_var

This is a plain text that will be inserted in an expandable heading for using this raw as an exampl

testheight

available

testulet

testvar

altscenario

This is a plain text that will be inserted in an expandable heading for using this raw as an example