Send a wire

Create an outgoing wire transfer

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Wire transfer request

amount · integer · required

Transfer amount in cents ($100 would be 10000)

Required range: x >= 1

Example:

10000

currency · enum<string> · required

3-character currency code

Available options:

USD

Example:

"USD"

customer_id · string<uuid> · required

The customer UUID representing the person initiating the Wire transfer

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

originating_account_id · string<uuid> · required

Sender account ID

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

receiving_account_id · string<uuid> · required

The external account uuid representing the recipient of the wire.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

recipient_message · string · required

Information from the originator to the beneficiary (recipient).

Maximum length: 140

bank_message · string

Instructions intended for the financial institutions that are processing the wire.

Maximum length: 210

metadata · object

Additional transfer metadata structured as key-value pairs

Response

201

application/json

Created wire

amount · integer · required

Transfer amount in cents ($100 would be 10000)

Example:

10000

creation_time · string<date-time> · required

Example:

"2010-05-06T12:23:34.321Z"

currency · string · required

3-character currency code

Example:

"USD"

effective_date · string<date> · required

The effective date of the transaction once it gets posted

Example:

"2022-03-18"

id · string<uuid> · required

wire ID

is_bulk · boolean · required

Whether or not the wire is a "bulk" wire created via the batch payment API.

last_updated_time · string<date-time> · required

Example:

"2010-05-06T12:23:34.321Z"

originating_account_number · string<string> · required

The account number representing the sender account. If the outgoing wire is a return, it refers to the sender of the initial wire not the sender of the return.

Example:

1961234745

receiving_account_number · string<string> · required

The account number representing the recipient account. If the outgoing wire is a return, it refers to the recipient of the initial wire not the destination of the return.

Example:

1961234745

sender_reference_id · string · required

Sender's id associated with fedwire transfer

Example:

"9F564A6124E65"

status · enum<string> · required

The current status of the transfer

Available options:

CANCELED,

COMPLETED,

DECLINED,

PENDING

Example:

"PENDING"

transaction_id · string<uuid> · required

ID of the resulting transaction resource

bank_message · string

Instructions intended for the financial institutions that are processing the wire.

batch_id · string<uuid>

The batch ID associated with the wire if it was created via the batch payment API.

case_id · integer

The case id associated with the wire.

Example:

53

customer_id · string<uuid>

The customer UUID representing the person initiating the Wire transfer

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

input_message_accountability_data · string

The input message accountability data consists of a 8 character cycle date (CCYYMMDD) an 8 character source and a 6 character sequence number.

Example:

"10220318BANK0001123456"

network · string

The network used to process the wire

Example:

"fedwire"

originating_account_id · string<uuid>

Sender account ID

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

receiving_account_id · string<uuid>

The external account uuid representing the recipient of the wire.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

recipient_message · string

Information from the originator to the beneficiary (recipient).

return_data · object

Data associated with a returned wire

Show child attributes

settlement_date · string<date>

The settlement date of the transaction once it gets posted

Example:

"2022-03-18"

status_details · enum<string>

Additional details about the status of the transfer

Available options:

APPROVED,

CANCELED,

DECLINED_DUAL_APPROVAL,

PENDING_DUAL_APPROVAL

Example:

"PENDING_DUAL_APPROVAL"

transaction_in_id · string<uuid>

The transaction uuid of the incoming wire that triggered an outgoing return. This is only used if the outgoing wire is a return.

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"