Bank rails

Wires

7min

Use wire transfers for both domestic and international payments. You or your customer can transfer money electronically to a recipient and a recipient can access the money, typically the same day.
Wire transfers go through Fedwire® , operated by the U.S. Federal Reserve.
In Cross River (CR), both inbound and outbound international wire transfers go through a domestic intermediary bank. To send or receive international wires in USD, you must contact the beneficiary bank to get the needed wire transfer information.
Wires APIs are found in the Wires module of our COS sandbox.
﻿Get started﻿ with Cross River APIs..
Wires APIs described on this page:
Action
API Call
Description
﻿Send a wire transfer﻿ 
POST /wires/v1/payments
Sends a single wire transfer payment
﻿Cancel a wire transfer﻿ 
POST /wires/v1/payments/{id}/cancel
Cancels a wire transfer payment
﻿Originate a drawdown request﻿ 
POST /wires/v1/payments/corporate-drawdown-requests
Requests an inbound payment by wire transfer
﻿Respond to a wires drawdown request﻿ 
POST /wires/v1/payments/{id}/drawdown-responses
Responds to a request for a payment by wire transfer
Send a wire transfer
POST
Request
Response
Body Parameters
accountNumber
required
String
Originator account number
originator
optional
Object
Originator of the payment

When calling the API, the originator on the outbound wire is either CR by default or the name of the account, depending on the configuration of your product.
businessFunctionCode
required
String
The business purpose of the wire transfer. The most common type is customer wire transfer (CTR) where the beneficiary isn't a bank.
receiverRoutingNumber
required
String
The 9-digit Fedwire routing number of the financial institution receiving the wire drawdown request. The ABA directory provides financial institution routing numbers.

9 characters maximum.
intermediaryFi
optional
Object
Intermediary bank involved in the transaction. Required when sending an international payment.
beneficiaryFi
optional
Object
Bank receiving the wire transfer
beneficiary
required
Object
Entity receiving the funds
beneficiaryReference
optional
String
Optional field for additional information. 16 characters maximum.
originatorToBeneficiary1
optional
String
Field for additional information from the originator to the beneficiary.

35 characters maximum.

You can add information in up to 4 originator to beneficiary fields (originatorToBeneficiary1, originatorToBeneficiary2, originatorToBeneficiary3, originatorToBeneficiary4).
amount
required
Integer
Dollar amount of wire transfer in positive integral cents. For example, write $1.00 as 100.
purpose
required
String
For internal CR use.

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.

50 characters maximum.
clientIdentifier
optional
String
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
﻿
Cancel a wire transfer
POST
Request
Path Params
id
required
String
Unique identifier for the payment in GUID format, received in the response to POST /wires/v1/payments. Also known as the payment ID.
﻿
Response attributes
The response attributes for this call are the same as for Send a wire transfer.
Originate a drawdown request
POST
Request
Body Parameters
accountNumber
required
String
ID of the cake to getThe account number being used to originate the outbound wire drawdown request .
originator
optional
Object
Originator of the payment.

When calling the API, the originator on the outbound wire is either CR by default or the name of the account, depending on the configuration of your product.
receiverRoutingNumber
required
String
The 9-digit Fedwire routing number of the financial institution receiving the wire drawdown request. The ABA directory provides financial institution routing numbers.
drawdownCreditAccountNumber
required
String
The 9-digit Fedwire routing number of the financial institution originating the wire drawdown request. The ABA directory provides financial institution routing numbers.
intermediaryFi
optional
Object
Intermediate bank involved in the transaction. Not all wire transactions use an intermediate FI.
beneficiaryFi
optional
Object
Bank that originates the wire drawdown request. In this case, Cross River.
drawdownDebitAccount
required
Object
Details of the account from which the funds will be debited.
beneficiary
optional
Object
For a drawdown request, this is the same as the originator object.
beneficiaryReference
optional
String
Optional field for additional information. 16 characters maximum.
originatorToBeneficiary1
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
originatorToBeneficiary2
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
originatorToBeneficiary3
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
originatorToBeneficiary4
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
debitDrawdownAdviceCode
optional
String
Additional wire information. One of:

- HLD (hold)
- LTR (letter)
- PHN (phone)
debitDrawdownInformation1
optional
String
Field for additional information about the drawdown debit account. 26 characters maximum.
debitDrawdownInformation2
optional
String
Field for additional information about the drawdown debit account. 33 characters maximum.
debitDrawdownInformation3
optional
String
Field for additional information about the drawdown debit account. 33 characters maximum.
debitDrawdownInformation4
optional
String
Field for additional information about the drawdown debit account. 33 characters maximum.
debitDrawdownInformation5
optional
String
Field for additional information about the drawdown debit account. 33 characters maximum.
receiverFiInformation1
optional
String
Field for additional information about the receiver financial institution. 30 characters maximum.
receiverFiInformation2
optional
String
Field for additional information about the receiver financial institution. 33 characters maximum.
receiverFiInformation3
optional
String
Field for additional information about the receiver financial institution. 33 characters maximum.
receiverFiInformation4
optional
String
Field for additional information about the receiver financial institution. 33 characters maximum.
receiverFiInformation5
optional
String
Field for additional information about the receiver financial institution. 33 characters maximum.
fiToFiInformation1
optional
String
Field for additional information to be sent from one financial institution to another. 35 characters maximum.
fiToFiInformation2
optional
String
Field for additional information to be sent from one financial institution to another. 35 characters maximum.
fiToFiInformation3
optional
String
Field for additional information to be sent from one financial institution to another. 35 characters maximum.
fiToFiInformation4
optional
String
Field for additional information to be sent from one financial institution to another. 35 characters maximum.
fiToFiInformation5
optional
String
Field for additional information to be sent from one financial institution to another. 35 characters maximum.
fiToFiInformation6
optional
String
Field for additional information to be sent from one financial institution to another. 35 characters maximum.
amount
required
Integer
Dollar amount of wire transfer in positive integral cents. For example, write $1.00 as 100.
purpose
optional
String
Reason for the wire transfer. For internal use only. The data is not included with the outgoing FedWire message.
clientIdentifier
optional
String
Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.
﻿
Response attributes
The response attributes for this call are the same as for Send a wire transfer.
Respond to a drawdown request
Responds to a wires drawdown request by sending payment.
POST
Request
Body Parameters
id
required
String
Payment ID of the drawdown request. This is in GUID format.
originator
required
Object
Details of the party sending the wire
beneficiaryReference
optional
String
Optional field for additional information. 16 characters maximum.
originatorToBeneficiaryLine1
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
originatorToBeneficiaryLine2
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
originatorToBeneficiaryLine3
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
originatorToBeneficiaryLine4
optional
String
One of 4 fields, 35 characters each, to add additional information to be sent to the beneficiary.
﻿
Response attributes
The response attributes for this call are the same as for Send a wire transfer.
Associated webhook events
Event Name
Description
Wire.Payment.Canceled
Outbound wire was canceled at the partner's request
Wire.Payment.Rejected
Outbound wire could not be processed due to compliance reasons or was rejected by the Federal Reserve
Wire.Payment.Processed
Outbound wire has been transmitted to the Federal Reserve. Still possible the wire could be rejected
Wire.Payment.Sent
Outbound wire has been transmitted to the Federal Reserve and has been successfully acknowledged. IMAD number is now available.
Wire.Payment.Received
Inbound wire has been received from another bank
Wire.Hold.Escalated
A hold relating to either an inbound or outbound wire was marked for escalation by a member of the Operations team. Commonly this is used to indicate additional documentation or action is needed by the partner.
Related topics
﻿Wire Transfers﻿ 
﻿Request and response codes﻿ 
﻿Error Codes﻿ 
Tutorials
﻿How to originate an outbound wire payment﻿ 
﻿Simulate inbound payments﻿ 
﻿Originate a drawdown request﻿ 
﻿Respond to a drawdown request﻿ 

Action	API Call	Description
Send a wire transfer	POST /wires/v1/payments	Sends a single wire transfer payment
Cancel a wire transfer	POST /wires/v1/payments/{id}/cancel	Cancels a wire transfer payment
Originate a drawdown request	POST /wires/v1/payments/corporate-drawdown-requests	Requests an inbound payment by wire transfer
Respond to a wires drawdown request	POST /wires/v1/payments/{id}/drawdown-responses	Responds to a request for a payment by wire transfer

Event Name	Description
Wire.Payment.Canceled	Outbound wire was canceled at the partner's request
Wire.Payment.Rejected	Outbound wire could not be processed due to compliance reasons or was rejected by the Federal Reserve
Wire.Payment.Processed	Outbound wire has been transmitted to the Federal Reserve. Still possible the wire could be rejected
Wire.Payment.Sent	Outbound wire has been transmitted to the Federal Reserve and has been successfully acknowledged. IMAD number is now available.
Wire.Payment.Received	Inbound wire has been received from another bank
Wire.Hold.Escalated	A hold relating to either an inbound or outbound wire was marked for escalation by a member of the Operations team. Commonly this is used to indicate additional documentation or action is needed by the partner.

🤔

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.

﻿

Updated 25 Sep 2024

Did this page help you?

Error codes

Request and response codes