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

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

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

Cancel a pending deposit using POST /checks/v1/payments/{id}/cancel.

Get extended check data

Cancel deposit

EKKO

ASHE

MORDEKAISER

AATROX

CRISTI_TEST

PREG

FDAT

International Organization for Standardization, a global organization that promotes commercial and industrial standards.

15-digit electronic ID number associated with the animal eartag

BDAT

CDAT

DairyComp 305 - VAS Dairy Management Software

DC305

DRPC

oocyte

Breeding Code

In-Vitro Fertilization. In relation to embryo transfers, IVF occurs when oocytes (eggs) are collected via OPU (ovum pick up), and then in a lab, semen is added to create embryos.

oocytes

National Association of Animal Breeders. www.naab-css.org

NAAB

EDAY

RPRO

SIRC

ETDAM

Vet Code 6 = ABT? Often if a dairy sees a pregnant animal showing signs of heat they may breed her. When this breeding is entered in DairyComp the animal remains pregnant, but this flag is set so that the veterinarian can determine if she is still pregnant to the original breeding or if she has aborted and is now just another "bred status" cow.

Vet Code 6 = ABT?

Dairy cattle typically have their hooves inspected and, if necessary, trimmed every 4–6 months. A strategic hoof-trimming program might evaluate hooves before first calving, between 60 and 150 days in milk, and before dry-off.

TRIM

hoof trim

A combination of ingredients used to make feed for animals

recipe

The dry weight of an ingredient with no mositure

DM/HD

BNAME

CNTL

VISID

The value that appears most often in a set of data.

Mode

SCPEN

Tech

Mastitis is the persistent, inflammatory reaction of the udder tissue due to physical trauma or infection. Symptoms of mastitis include udder swelling, heat, hardness, redness, or pain. The milk may have a watery appearance, flakes, clots, or pus.

Mastitis

mastitis

Metritis is inflammation of the wall of the uterus, and usually occurs within days of calving. Symptoms of metritis are an enlarged uterus and a foul-smelling uterine discharge.

metritis

Pneumonia is lung inflammation caused by a bacterial or viral infection. Early symptoms may include fever, depression, reduced appetite, nasal and eye discharge, salivation, shallow breathing, and soft coughing.

Pneumonia

Lameness includes any abnormality which causes an animal to change the way it walks, and can be caused by a range of foot and leg conditions, including hoof ailments, hock damage, bruising, sores, or cuts.

Lame

Diarrhea in young animals. Scours causes dehydration in calves and is the leading cause of death in calves under one month of age.

Scours

Retained placenta is the failure to expel fetal membranes within 24 hours after parturition. The primary symptom of a retained placental is degenerating, discolored, and ultimately fetid membranes hanging from the vulva.

Retained Placenta

Ketosis is a common ailment that usually occurs in early lactation, when the energy demands of milk production are very high and the cow metabolizes fat stores for energy. Symptoms of ketosis may include reduced milk yield, weight loss, reduced appetite, acetone smell of breath and/or milk, and fever.

Ketosis

Milk fever is a disease characterized by reduced blood calcium levels. It occurs in early lactation, when demand for calcium for colostrum and milk production exceeds the cow's ability to mobilize calcium. "Fever" is a misnomer, as body temperature during the disease is generally not elevated. Milk fever symptoms include tremor in the muscles of the head and limbs until falling to a "sitting" position. Once down, cows may have a dry muzzle, staring eyes, cold legs and ears, constipation, and drowsiness.

Milk Fever

Displaced abomasum in cattle occurs when the abomasum, also known as the true stomach, which typically resides on the floor of the abdomen, fills with gas and rises to the top of the abdomen, where it is said to be "displaced". Symptoms may include reduced appetite, lower milk yield, reduced rumination, and a distended abdomen.

Displaced Abomasum

EDAT

retained placenta

KPIs

The term "Zone" represents different dairy locations. Platform Zones may be different physical dairy locations (for example, multiple locations across the state or country) or different user-defined locations within a single dairy site (for example, Pens 1-100 are Zone 1, Pens 101-200 are Zone 2, etc.).

Zone

Allows you to manage the dairy's billing account for the VAS PULSE Platform.

Billing Management

Allows you to create new Dairy Dashboards and customize the widgets displayed on existing ones.

Dashboard Management

Dashboard View

Allows you to upload, download, and manage shared files, including the ability to create, edit, delete, and view file history details, in any domain.

File Management

Allows you to download and view history details for general shared files not associated with Herd, Feed, and Parlor data.

General

Allows you to manage Platform integration with other applications that send data to or extract data from Platform (for example, DairyComp for DC Unlimited subscribers, FeedComp, Parlors, and other allowed 3rd‑party software integrations).

Integration Management

Allows you to edit the dairy profile settings under Dairy Configuration > Dairy Information (dairy description, discoverability, address, etc.).

Profile Management

Allows you to invite new users, remove existing users, and manage role and permission settings for other users.

User Management

Allows you to create and manage dairy Zones. The term "Zone" represents different dairy locations. Platform Zones may be different physical dairy locations (for example, multiple locations across the state or country) or different user-defined locations within a single dairy site (for example, Pens 1-100 are Zone 1, Pens 101-200 are Zone 2, etc.).

Cancel deposit

Relevant webhooks

API reference