Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Wires

Update an incoming wire by id

Update an incoming wire by id

patch/wires/incoming/{wire_id}

Path parameters

wire_idstring uuid required
Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

The unique identifier of a wire transfer.

Request body

Example request

{
  "return_data": {
    "reason_code": "NARR"
  }
}

Response

wire

amountinteger required

Transfer amount in cents ($100 would be 10000)

bank_messagestring

Information from the sending bank to the receiving bank.

creation_timestring date-time required
currencystring

3-character currency code

customer_idstring uuid

The customer UUID representing the person initiating the Wire transfer

decline_reasonstring

Description of any errors or problems encountered during processing.

effective_datestring date

The effective date of the transaction

end_to_end_identificationstring

A mandatory reference assigned by the customer originating the payment, i.e., Debtor or Ultimate Debtor that must be transported unchanged throughout the payment chain and delivered to the end-customer, i.e., Creditor or Ultimate Creditor to facilitate the customer’s reconciliation.

extracted_account_numberstring

Account number recovered from the unstructured recipient message when the structured beneficiary account number was missing or unusable. When the value matches a known account exactly, the wire is forwarded to the standard posting flow; otherwise it falls to suspense and ops can review this candidate.

idstring uuid required

wire ID

input_message_accountability_datastring

The IMAD of the incoming wire. The field is called Message Identification in the ISO format.

instruction_identificationstring

An optional reference that the Fedwire Funds participant sending the message may include in a customer credit transfers sent across the Fedwire Funds Service and will be delivered unchanged to the Fedwire Funds participant receiving the message.

is_returnboolean required

Indicates if the wire is a return of an outgoing wire

networkstring

The network used to process the wire

originating_account_numberstring string

The account number of the sender, as provided in the wire file.

receiving_account_idstring uuid

The internal Synctera account uuid representing the recipient of the wire.

receiving_account_numberstring string required

The account number of the recipient, as provided in the wire file.

recipient_messagestring

Information from the originator to the beneficiary (recipient).

return_reasonstring

The reason we are returning this wire.

sender_reference_idstring required

Sender's id associated with fedwire transfer

settlement_datestring date

The settlement date of the transaction

status'BLOCKED' | 'POSTED' | 'READY' | 'RETURNED' required

The current status of the transfer

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

transaction_idstring uuid

ID of the resulting transaction resource

transaction_identificationstring

An optional reference that the first financial institution in the end-to-end payment chain may assign to the customer credit transfer and that should remain unchanged throughout the end-to-end funds-transfer chain of financial institutions.

type_subtype'BASIC_FUNDS_TRANSFER' | 'PRIOR_DAY_TRANSFER_REVERSAL' | 'RETURN' | 'SAME_DAY_TRANSFER_REVERSAL'

The fedwire label associated with the subtype code

uetrstring uuid

Unique End-To-End Reference (UETR) is a mandatory reference in line with the Universally Unique Identifier (UUID) version 4 standard. The UETR is used to facilitate end-to-end payments tracking.

Example response

{
  "amount": 10000,
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "effective_date": "2022-03-18",
  "extracted_account_number": "1961234745",
  "input_message_accountability_data": "10220318BANK0001123456",
  "network": "fedwire",
  "receiver": {
    "address": {
      "address_line_1": "321 Main St",
      "address_line_2": "Apt 34",
      "city": "Chicago",
      "country_code": "US",
      "postal_code": "60622",
      "state": "IL"
    },
    "bank_name": "Synctera Bank",
    "identifier_type": "Demand Deposit Account Number",
    "name": "John Smith"
  },
  "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "return_data": {
    "reason_code": "NARR"
  },
  "sender": {
    "address": {
      "address_line_1": "321 Main St",
      "address_line_2": "Apt 34",
      "city": "Chicago",
      "country_code": "US",
      "postal_code": "60622",
      "state": "IL"
    },
    "bank_name": "Synctera Bank",
    "identifier_type": "Demand Deposit Account Number",
    "name": "John Smith"
  },
  "sender_reference_id": "9F564A6124E65",
  "settlement_date": "2022-03-18",
  "status": "READY",
  "tenant": "abcdef_ghijkl",
  "type_subtype": "BASIC_FUNDS_TRANSFER"
}