---
title: "Update a Wire Transfer"
method: PATCH
path: "/wire/{id}"
tags: ["Wire"]
---

# Update a Wire Transfer

`PATCH /wire/{id}`

## Path parameters

- `id` string, required — Unique identifier for object

## Request body

- object
  - `status` string — New status for wire, one of: `canceled`
  - `userdata` object — Arbitrary data the user can attach to the object

## Response `200`

The wire updated

- object
  - `account_id` string — ID of the Account originating the transfer. Filterable.
  - `amount` string — Amount of money to transfer, with two decimal precision
  - `bankdata` object — Optional arbitrary data the bank can attach to the object
  - `chips_ssn` string — Optional value for Chips SSN
  - `counterparty_id` string — ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.
  - `error` string — Error message describing why a wire failed
  - `fx_quote` object — Associated foreign exchange quote, if any. Only present for wires at some bank partners.
    - `base_currency` string — Starting currency for the foreign exchange quote
    - `rate` number, float
    - `status` string — Status of the foreign exchange quote
    - `target_currency` string — Target currency for the foreign exchange quote
  - `id` string — Unique identifier for object
  - `imad` object — Optional Input Message Accountability Data. An ID often filled out by the banks, originating from fed processing
    - `parsed` object — Parsed IMAD sub-object
      - `cycle_date` string — Wire transfer date. YYYYMMDD
      - `input_sequence_number` string — A 6 digit number assigned for uniqueness
      - `input_source` string — 8 Alpha or Alpha-Numeric characters identifying the source
    - `unparsed` string — Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService
  - `instructions` string — Optional instructions for the recipient (maximum of 140 characters)
  - `intermediary` object — Optional intermediary bank information. If the recipient's bank is unable to receive a wire transfer, they will use an intermediary bank to process the wire
    - `address` object — Physical address of the bank
      - `city` string — City (max 18 characters)
      - `country` string — Country (ISO 3166-1 alpha-2). Defaults to `US`
      - `postal_code` string — Postal code (5-digit or 5+4 Zip Code for U.S. addresses)
      - `state` string — State (max 2 characters for US, max 3 characters for other countries)
      - `street_line_1` string — First line of the address (max 35 characters)
      - `street_line_2` string — Optional second line of the address (max 35 characters)
    - `name` string — Name of the bank (maximum of 35 characters)
    - `routing_number` string — Valid 9-digit ABA routing transit number associated with the bank
  - `omad` object — Optional Output Message Accountability Data. An ID originating from fed processing, similar structure to IMAD but with more info
    - `parsed` object — Parsed OMAD sub-object
      - `cycle_date` string — Wire transfer date. YYYYMMDD
      - `frb_application_id` string — Uniquely identifies the Fedwire Funds Service site that processed the message (i.e., FT01, FT02 or FT03)
      - `output_date` string — 4 digit MMDD. Paired with `output_time`
      - `output_destination` string — 8 Alpha or Alpha-Numeric characters identifying the destination. Comparable to the IMAD `input_source`
      - `output_sequence_number` string — A 6 digit number assigned for uniqueness. Comparable to IMAD `input_sequence_number`
      - `output_time` string — 4 digit HHmm. Paired with `output_date`
    - `unparsed` string — Output Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService
  - `org_id` string — ID of the organization with which this object is associated. Filterable.
  - `purpose` string — Optional string identifying the reason for why these funds are being transferred. For example Payroll, Tuition, Travel, etc. Required if sending an international wire (maximum of 35 characters, may be truncated to 16 characters for sending depending on bank)
  - `status` string — One of `pending`, `canceled`, `error`, or `sent`. Filterable.
  - `target_currency_code` string — Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.
  - `uetr` string — Optional Unique End-to-end Transaction Reference. A UUID that identifies the wire end-to-end, originating from ISO 20022 processing
  - `userdata` object — Optional arbitrary data the user can attach to the object

---

[API](https://skmtc.net/treasuryprime/apis/account.md) · [All operations](https://skmtc.net/treasuryprime/apis/account/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/treasuryprime/account/revisions/95a3c69c14e8/schema)