Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Wires

Send a wire

Create an outgoing wire transfer

post/wires

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

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.

Request body

amountinteger required

Transfer amount in cents ($100 would be 10000)

bank_messagestring

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

currency'USD' required

3-character currency code

customer_idstring uuid required

The customer UUID representing the person initiating the Wire transfer

metadataobject

Additional transfer metadata structured as key-value pairs

originating_account_idstring uuid required

Sender account ID

receiving_account_idstring uuid required

The external account uuid representing the recipient of the wire.

recipient_messagestring required

Information from the originator to the beneficiary (recipient).

Example request

{
  "amount": 10000,
  "currency": "USD",
  "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96"
}

Response

Created wire

amountinteger required

Transfer amount in cents ($100 would be 10000)

bank_messagestring

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

batch_idstring uuid

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

case_idinteger

The case id associated with the wire.

creation_timestring date-time required
currencystring required

3-character currency code

customer_idstring uuid

The customer UUID representing the person initiating the Wire transfer

effective_datestring date required

The effective date of the transaction once it gets posted

fed_input_message_accountability_datastring

The Synctera-generated IMAD can be overwritten when the wire is uploaded to the FED. If that happens and we are provided with the new IMAD, it will be populated in this field.

idstring uuid required

wire ID

input_message_accountability_datastring

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

is_bulkboolean required

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

last_updated_timestring date-time required
networkstring

The network used to process the wire

originating_account_idstring uuid

Sender account ID

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

receiving_account_idstring uuid

The external account uuid representing the recipient of the wire.

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

recipient_messagestring

Information from the originator to the beneficiary (recipient).

sender_reference_idstring required

Sender's id associated with fedwire transfer

settlement_datestring date

The settlement date of the transaction once it gets posted

status'CANCELED' | 'COMPLETED' | 'DECLINED' | 'PENDING' required

The current status of the transfer

status_details'APPROVED' | 'CANCELED' | 'DECLINED_DUAL_APPROVAL' | 'PENDING_DUAL_APPROVAL' | 'SUSPENDED_OFAC_REVIEW'

Additional details about the status of the transfer

transaction_idstring uuid required

ID of the resulting transaction resource

transaction_in_idstring 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 response

{
  "amount": 10000,
  "case_id": 53,
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "effective_date": "2022-03-18",
  "fed_input_message_accountability_data": "10220318BANK0001123456",
  "input_message_accountability_data": "10220318BANK0001123456",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "network": "fedwire",
  "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "return_data": {
    "reason_code": "NARR"
  },
  "sender_reference_id": "9F564A6124E65",
  "settlement_date": "2022-03-18",
  "status": "PENDING",
  "status_details": "PENDING_DUAL_APPROVAL",
  "transaction_in_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96"
}