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

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

returnCode

More information about the reason for the return. 34 character maximum.

reasonData

Unique identifier of the original ACH payment to be returned

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 orinigate 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

Reason code for why the payment was rejected: 
- 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

Required if the SEC code is IAT. See here for more information about IAT.

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.

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

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

Cancel batch

Returns

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