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

Unique identifier for the payment in GUID format, received in the response to POST /wires/v1/payments. Also known as the payment ID.

The payment ID. First appears in the initial response to the originate a payment request. This ID is in GUID format.

CR Account number. In CR, depending on the account type, the number of digits will vary. The first digit indicates the kind of account.

accountNumber

Internal CR unique ID for the transaction

coreTransactionId

Unique reference ID for the payment. The reference ID always begins with the first letter of the rail. For wires the reference ID starts with 'W'.

referenceId

Unique identifier in GUID format for the Federal Reserve batch the payment went out on (or came in on for inbound payments)

fedBatchId

fedBatchSequence

direction

Transfer, Drawdown, DrawdownResponse, ServiceMessage, Reversal

paymentType

Method used to send payment instructions: Phone, fax, email, file, API, partner portal, Ops portal.

source

Payment status: Created, Pending, Hold, Batched, Processing, Completed, Rejected, Canceled, Blocked

status

Posting status: Pending, Posted, Failed, Canceled

posting

Rejected because: OfacCancel, UnableToDetermine, OfacConfirmed, OfacUnconfirmed, Other

rejectionReason

blockedReason

Partner authorization for out-of-band payment requests: NotRequired, Pending , Approved, Canceled

partnerAuthorization

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

authorizedAt

CR user ID of the partner user who authorizes the wire

authorizedById

CR username of the partner user who authorizes the wire

authorizedByName

Second partner authorization for out-of-band payment requests: NotRequired, Pending , Approved, Canceled

partnerAuthorization2

authorizedAt2

authorizedById2

authorizedByName2

Dollar amount of wire transfer in positive integral cents. For example, write $1.00 as 100.

amount

currency

Reason for the wire transfer, such as "daily settlement." Also use this field if you submit multiple wires for the same amount, such as "1 of 2, 2 of 2." This data is not included with the outgoing FedWire message.

purpose

Input Messaging Accountability Data. A combination of a date, source identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application. Unique to the payment.

imad

Output Messaging Accountability Data. A combination of a date, destination identifier, and sequence number assigned to a Fedwire message when it is processed by the Federal Reserve Bank Funds Transfer application.

omad

The business purpose of the wire transfer. The most common type is customer wire transfer (CTR) where the beneficiary isn't a bank. See the full list of codes and descriptions.

businessFunctionCode

The type code value provides information about the type of wire transfer sent (type code, first 2 digits) and more details about the transfer (subtype code, second 2 digits).

typeCode

Fedwire routing number for the sender's bank

senderRoutingNumber

senderName

senderReference

The 9-digit Fedwire routing number of the financial institution receiving the wire drawdown request. The ABA directory provides financial institution routing numbers.

receiverRoutingNumber

receiverName

Details of the financial institution sending the wire

originatingFi

originator

Details of any intermediary bank involved in the wire transaction. Not all wire transfers use an intermediary FI.

intermediaryFi

Details of the financial institution receiving the wire

beneficiaryFi

beneficiary

Field for additional information from the originator to the beneficiary.

originatorToBeneficiary1

Optional field for additional information. 16 characters maximum.

beneficiaryReference

Month and day the wire was received in the format mmdd

receiptDate

Time the wire was received, in the format hhmm

receiptTime

True if the payment was reversed, otherwise false

wasReversed

True if the payment is international, otherwise false

isInternational

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

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 released in a distribution to the Fed. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm].

releasedAt

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

processedAt

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

Business date on which the payment is effective

effectiveDate

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 CR account. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

postedAt

Payment ID of a previously sent wire that was reversed. Otherwise, the same as the payment ID.

originalPaymentId

Your ID in the CR 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 CR.In this case, the CR account involved in the payment. More about Product IDs.

productId

Internal CR value. Date and time the database entry was last modified.

lastModifiedAt

Includes OK (posted), RES (account restricted), NSF (insufficient funds in the account sending the wire)

postingCode

Wire transfer

Cancel transfer

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