Initiates a return for an existing ACH payment. Returns must include a valid Nacha return code, can also include descriptive metadata. Returned payments reference the original transaction and include updated payment details.

Endpoint: /ach/v1/payments/{id}/returns

The new payment ID for the return, in GUID format. The original payment ID appears in the original and previous objects.

Cross River account number for payment originator.  Depending on the account type, the number of digits will vary. The first digit indicates the kind of account.

accountNumber

Unique Cross River reference ID for the payment. The reference ID always begins with the first letter of the rail. For ACH the reference ID starts with 'A'.

referenceId

What kind of payment was sent, for example, origination or return. See the ACH Request and response codes page for a list of payment types.

paymentType

The payment direction, which includes:
- Inbound: payment received by a Cross River account from another bank
- Outbound: a payment sent from a Cross River account to another bank

direction

Current lifecycle status of the payment, for example, Created, Processing, or Completed. See the ACH Request and response codes page for a list of payment statuses.

status

Payment channel:
- Api
- PartnerPortal
- OpsPortal
- File

source

How the payment is grouped for posting:
- Individual
- Aggregate (batch)

postingType

Identifier (GUID) used to group related client payments in batch submissions, if you originate the client batch

clientBatchId

Sequence number of the payment in the batch, if you originate the client batch

clientBatchSequence

Fedwire or ACH batch ID used for settlement tracking

fedBatchId

Sequence of the payment inside of the batch sent to or received from the Fed

fedBatchSequence

Internal Cross River unique ID for the transaction

coreTransactionId

ID representing the memo post associated with this transaction

memoPostId

Code representing the posting category used internally

postingCode

The related Cross River system transaction status. When you originate a payment, the system initially returns OK. If the payment fails or is declined, the value changes to a Cross River system-generated code:
- Pending
- Posted
- Failed
- Canceled
- Authorized
- Processing

posting

Rejected because: 
- OfacUnableToDetermine
- OfacConfirmed
- OfacUnconfirmed
- Other

rejectionReason

Reason for any OFAC or compliance-based block:
- Ofac
- Other

blockedReason

originator

receiver

Standard Entry Class (SEC) code required by Nacha for every ACH transaction. See the ACH Request and response code page.

secCode

Description of the payment provided at origination

description

Sending or requesting funds:
- Push (originator is sending funds—debit)
- Pull (originator is receiving funds—credit)

transactionType

Dollar amount of payment in positive integral cents. For example, $1.00 appears as 100.

amount

When the payment completes:
- Standard (Payment effective the following business day. International payments must use this service type.)
- SameDay (Payment effective same day, subject to certain constraints. See ACH overview.)

serviceType

ACH-specific fields. Learn more on the Nacha site.

extendedDetails

International ACH details. 
This object is only returned for the IAT secCode.

iatDetails

Supplemental data to identify an account holder or provide information about the payment. This may include details such as invoice numbers.

addenda

Effective date of the ACH payment (YYYY-MM-DD)

effectiveDate

Valid ACH return code explaining the return reason in accordance with NACHA guidelines (for example, R01, R02). See the ACH Request and Response Codes page for the return codes. 

reasonCode

More information about the reason for the return.

reasonData

Unique ACH trace number for the transaction

traceNumber

Date payment settled in the receiver's account

settlementDate

True if payment was returned. Otherwise false.

wasReturned

True if a payment is sent with bad info but the receiving FI fixes it and sends back the information (NOC). Otherwise false.

wasCorrected

For ACH pulls, allows defining a number of days to delay credit of funds to an account to mitigate fraud and NSF scenarios

holdDays

original

Date and time the payment was created in the system. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

createdAt

Date and time the 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 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 payment was blocked by BSA/AML. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

blockedAt

Date and time the payment was processed by Cross River. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

processedAt

Date and time the payment was systemically completed. This can only occur after the payment has successfully posted to the account. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

completedAt

Date and time the payment was posted to the Cross River account. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

postedAt

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

partnerId

ID in GUID format of your specific product type on which the account is based. Provided by Cross River. In this case, the Cross River account involved in the payment.

productId

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

Reason for the ACH transfer. For internal use only. The data is not included with the outgoing ACH batch file.

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

externalPrefix

externalAccountNumber

Initiate a return for an existing ACH payment using POST /ach/v1/payments/{id}/returns, including a valid NACHA return code.

Reversals

Returns

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

Returns

﻿API reference﻿

API reference