Endpoint: /wires/v1/payments

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

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

accountNumber

Internal Cross River unique ID for the transaction

coreTransactionId

Unique Cross River reference ID for the payment

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:
- OfacCancelUnableToDetermine
- 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

Cross River user ID of the partner user who authorizes the wire

authorizedById

Cross River 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. 35 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 Cross River. 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 Cross River 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 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. More about Product IDs.

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

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

postingCode

If Originator is null or empty, the system will use the configured account/product originator.

If the configured account/product originator contains any of the following ID codes, the request will be rejected:

Intermediary FI and Beneficiary FI Uniqueness

If both are specified with the same identifier, the request will be rejected.

IntermediaryFi and BeneficiaryFi cannot be identical.

Must be validated as a person or organization.

Errors follow the person/organization validation rules.

Must be validated as a financial institution.

Errors follow the financial institution validation rules.

Beneficiary FI (if not explicitly provided — no ID Code or Identifier specified)

Derived from the Receiver Routing Number:

Initiate a single wire transaction via POST /wires/v1/payments with sender, beneficiary, and funding details for domestic or international transfers.

Wires postal address update (November 2027)

Wire transfer

Electronic Commerce Indicator. A code that signifies the type of electronic commerce transaction during payment processing. It distinguishes between transaction categories, particularly in transactions where the card is not physically present. 

Cardholder Authentication Verification Value. A cryptographic token generated by the card issuer’s Access Control Server (ACS) during a 3D Secure (3DS) authentication process.

CAVV

Strong Customer Authentication. This is a regulatory requirement that mandates multi-factor authentication for electronic payments to enhance security and reduce fraud.

Virtual Private Cloud. A global virtual network that spans all regions and lets you isolate your resources within projects.

Card Verification Code. A three-digit security codes on Mastercard payment cards used to verify cardholder possession during online or phone transactions.

Card Verification Value. A three-digit security codes on VISA payment cards used to verify cardholder possession during online or phone transactions.

Payment Card Industry Data Security Standard. Created to improve and streamline the security controls organizations use when handling cardholder data and reduce credit card fraud.

PCI_DSS

Payment Services Directive 2 is a EU regulation that aims to enhance the safety and security of payment services and promote innovation and competition in the market.

PSD2

The Federal Reserve Banks use the X9 industry standard to safely exchange check data and digital check images with other banks. This electronic format allows banks to process and transfer check deposits quickly without needing to mail the origin

X9_check_standard

This is an international electronic money transfer for friends and family to send money to those across borders quickly and easily.

remittance_transfer

This is any entity that regularly sends money from consumers to businesses and individuals in other countries. This includes banks and financial service institutions that conduct remittance transfers as part of their normal business operations.

remittance_transfer_provider

The net transfer of funds between the issuer and acquirer, facilitated by the card network, to fulfill the financial obligations of cleared transactions (typically T+1).​

Settlement_in_Cards

An issuing processor authorizes or declines card transactions on behalf of the issuing bank. Cross River has an in-house card issuing processing engine called P1. ​

Issuing_Processor

Fee paid between banks for acceptance of card-based transactions, facilitated via the card networks.​

Interchange

Process by which the merchant's final transaction details are submitted through the card network to the issuer.​

Clearing

The Merchant’s bank in the Four Party Model (cardholder, merchant, acquiring bank, network, issuing bank). Charges MDR to Merchant, pays Interchange card networks.

Acquiring_Bank

Me2Me payments involve a person or entity transferring funds between two accounts that they own.

Me2Me

Wallet defunding refers to the process of moving money from digital wallets back to bank accounts.

Wallet_Defunding

A descriptive reference used to define a range of accounts not held in Cross River. The prefix then is tied to a partners FBO account.

external_account_prefix

Three-Domain Secure is a security protocol designed to enhance the security of online credit and debit card transactions, helping to prevent fraud and unauthorized use.

Primary Account Number. A unique identifier, typically 14 to 19 digits, found on credit, debit, and other payment cards that indicates the card issuer and the individual cardholder.

SAS Anti-Money Laundering. This system helps institutions detect and prevent illicit activity while maintaining regulatory compliance, using advanced detection, AI, and machine learning to strengthen monitoring and protect against financial crime.

SAS_AML

ClaveBancaria Estandarizada is a standardized banking code used in Mexico to identify bank accounts. It consists of 18 digits that include the bank code, branch location, and account number. 

CLABE

Accounting for Financial Liabilities. Refers to receipts or payments from personal non-resident bank accounts. Helps financial institutions identify the nature of the transactions being processed, ensuring accurate reporting and compliance.

Accounting for Financial Assets. Refers to receipts or payments from personal resident bank accounts or deposits. Helps financial institutions identify the nature of the transactions being processed, ensuring accurate reporting and compliance.


Customer Identification File. A digital record that contains comprehensive details about a bank’s customers. It serves as a centralized repository for essential information related to an individual's banking relationship.

Fair banking is the principle and practice of providing equal and non-discriminatory access to financial services, ensuring that decisions by banks are based on objective risk rather than political, religious, or ideological affiliations.

Fair_Banking

Fair_Lending

Account Funding Transaction.  Pull funds from a debit card for specific purposes. Use an AFT to fund a wallet or prepaid card, or to initiate a person-to-person (P2P) transfer through the card network rails. AFTs are not allowed for purchases.

A 32-character hexadecimal string with hyphens, such as 123e4567-e89b-12d3-a456-426655440000 used as a unique identified. Sometimes called a UUID.

GUID

Know Your Business processes verify legitimacy business entities and their ownership structures to prevent financial crime and comply with regulations. KYB requires information including company registrations and operational activities. See also KYC.

Know Your Customer processes verify the identity of an individual customer to prevent financial crime and comply with regulations. KYC uses personal details and identity documents for this verification.

A GUID assigned to you by Cross River. This ID is required for some API calls.

Partner_ID

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.

Wire transfer

Relevant webhooks

API reference

Validation Rules

Default Values