Wires APIs

accountNumber

string

Required  

Originator account number

originator

object

Conditional 

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.

child attributes

idCode string Required   Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes. For outbound payments where originator details are submitted with the payment request, the value of this field should be D, and the value for the identifier should be the number of the account originating the payment.

identifier string Required   A number or string that provides unique identification, such as a driver's license number for an individual, or a Fed routing number for an FI. For outbound payments where originator details are submitted with the payment request, this is the customer account number. Otherwise, the system automatically populates this field. 34 characters maximum.

name string Required   Originator name. Maximum 35 characteres.

address1 string Optional  Field of 35 characters usually used for the street address

address2 string Optional  Field of 35 characters usually used for the city, state, and postal code

address3 string Optional  Field of 35 characters for any information, for example, country code or information related to the wire

businessFunctionCode

string

Required  

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

receiverRoutingNumber

string

Required  

Fedwire routing number of the beneficiary (receiver) bank. The ABA directory provides financial institution routing numbers.

9 characters maximum.

intermediaryFi

object

Conditional 

Intermediary bank involved in the transaction. Required when sending an international payment.

child attributes

idCode string Required   Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.

identifier string Required   A number or string that provides unique identification, such as a driver's license number for an individual, or a Fed routing number for an FI. In this object, enter an identifier for the intermediary bank involved with the wire transaction. 34 characters maximum.

name string Required   Intermediary financial institution name. Maximum 35 characters.

address1 string Optional  Field of 35 characters usually used for the street address

address2 string Optional  Field of 35 characters usually used for the city, state, and postal code

address3 string Optional  Field of 35 characters for any information, for example, country code or information related to the wire

beneficiaryFi

object

Optional 

Bank receiving the wire transfer

child attributes

idCode string Required   Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes. For outbound payments, the value for the beneficiary FI is F to indicate the bank Fed routing number. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field.

identifier string Required   A number or string that provides unique identification, such as a driver's license number for an individual, or a Fed routing number for an FI. For outbound payments, enter the bank Fed routing number for the beneficiary FI. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field. 34 characters maximum.

name string Required   Beneficiary financial institution name. Maximum 35 characters.

address1 string Optional  Field of 35 characters usually used for the street address

address2 string Optional  Field of 35 characters usually used for the city, state, and postal code

address3 string Optional  Field of 35 characters for any information, for example, country code or information related to the wire

beneficiary

object

Required  

Entity receiving the funds

child attributes

idCode string Required   Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes. For outbound payments, this is D to indicate a deposit account.

identifier string Required   A number or string that provides unique identification, such as a driver's license number for an individual, or a Fed routing number for an FI. For outbound payments, this is the beneficiary's account number. 34 characters maximum.

name string Required   Beneficiary name. Maximum 35 characters.

address1 string Optional  Field of 35 characters usually used for the street address

address2 string Optional  Field of 35 characters usually used for the city, state, and postal code

address3 string Optional  Field of 35 characters for any information, for example, country code or information related to the wire

beneficiaryReference

string

Optional 

Optional field for additional information. 16 characters maximum.

originatorToBeneficiary1

string

Optional 

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

integer

Required  

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

purpose

string

Required  

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.

id

string

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

accountNumber

string

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

coreTransactionId

string

Internal CR unique ID for the transaction

referenceId

string

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

fedBatchId

string

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

fedBatchSequence

integer

Sequence number of payment in batch

direction

string

Inbound or outbound

paymentType

string

Transfer, Drawdown, DrawdownResponse, ServiceMessage, Reversal

source

string

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

status

string

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

posting

string

Posting status: Pending, Posted, Failed, Canceled

rejectionReason

string

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

blockedReason

string

Blocked because: OfacMatch, Other

partnerAuthorization

string

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

authorizedAt

date-time

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

authorizedById

string

CR user ID of the partner user who authorizes the wire

authorizedByName

string

CR username of the partner user who authorizes the wire

partnerAuthorization2

string

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

authorizedAt2

date-time

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

authorizedById2

string

CR user ID of the partner user who authorizes the wire

authorizedByName2

string

CR username of the partner user who authorizes the wire

amount

integer

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

currency

string

Currency of funds transfer

purpose

string

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.

imad

string

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.

omad

string

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.

businessFunctionCode

string

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

typeCode

string

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

senderRoutingNumber

string

Fedwire routing number for the sender's bank

senderName

string

Entity sending the wire

senderReference

string

Sender assigned reference number

receiverRoutingNumber

string

Fedwire routing number of the beneficiary (receiver) bank. The ABA directory provides financial institution routing numbers.

receiverName

string

Name of the FI receiving the funds

originatingFi

object

Details of the financial institution sending the wire

child attributes

idCode string Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.

identifier string Identifier at the financial institution sending the wire

name string Name of the originating financial institution

address1 string Field of 35 characters usually used for the street address

address2 string Field of 35 characters usually used for the city, state, and postal code

address3 string Field of 35 characters for any information, for example, country code or information related to the wire

originator

object

Details of the party sending the wire

child attributes

idCode string Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.

identifier string Identifier for the party sending the wire. For outbound payments where originator details are submitted with the payment request, this is the customer account number. Otherwise, the system automatically populates this field.

name string Originator name. Maximum 35 characteres.

address1 string Field of 35 characters usually used for the street address

address2 string Field of 35 characters usually used for the city, state, and postal code

address3 string Field of 35 characters for any information, for example, country code or information related to the wire

intermediaryFi

object

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

child attributes

idCode string Specifies the type of value in the identifier field that follows it. 1 character. See the list of ID codes.

identifier string Identifier for the intermediary bank involved with the wire transaction.

name string Intermediary financial institution name. Maximum 35 characters.

address1 string Field of 35 characters usually used for the street address

address2 string Field of 35 characters usually used for the city, state, and postal code

address3 string Field of 35 characters for any information, for example, country code or information related to the wire

beneficiaryFi

object

Details of the financial institution receiving the wire

child attributes

idCode string Identifier code for the bank receiving the wire. For outbound payments, this is "F" to indicate the bank Fed routing number. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field.

identifier string Identifier for the bank receiving the wire. For outbound payments, this is the bank Fed routing number. This field is optional for domestic wires because the system automatically uses the banking information for the value entered into the receiverRoutingNumber field.

name string Beneficiary financial institution name. Maximum 35 characters.

address1 string Field of 35 characters usually used for the street address

address2 string Field of 35 characters usually used for the city, state, and postal code

address3 string Field of 35 characters for any information, for example, country code or information related to the wire

beneficiary

object

Details of the party receiving the wire

child attributes

idCode string Identifier code for the party receiving the wire. For outbound payments, this is "D" to indicate a deposit account.

identifier string Identifier for the party receiving the wire. For outbound payments, this is the beneficiary's account number.

name string Beneficiary name. Maximum 35 characters.

address1 string Field of 35 characters usually used for the street address

address2 string Field of 35 characters usually used for the city, state, and postal code

address3 string Field of 35 characters for any information, for example, country code or information related to the wire

originatorToBeneficiary1

string

Field for additional information from the originator to the beneficiary.

beneficiaryReference

string

Optional field for additional information. 16 characters maximum.

receiptDate

string

Month and day the wire was received in the format mmdd

receiptTime

string

Time the wire was received, in the format hhmm

wasReversed

boolean

True if the payment was reversed, otherwise false

isInternational

boolean

True if the payment is international, otherwise false

clientIdentifier

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.

createdAt

string

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]

releasedAt

date-time

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

processedAt

string

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

canceledAt

string

Date and time the payment was canceled

rejectedAt

string

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

blockedAt

string

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

effectiveDate

string

Business date on which the payment is effective

completedAt

string

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

postedAt

date-time

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]

originalPaymentId

string

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

partnerId

string

Your ID in the CR system. This ID is in GUID format.

productId

string

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.

lastModifiedAt

string

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