Sign in
Wire

Update a Wire Transfer

patch/wire/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Request body

statusstring

New status for wire, one of: canceled

userdataobject

Arbitrary data the user can attach to the object

Response

The wire updated

account_idstring

ID of the Account originating the transfer. Filterable.

amountstring

Amount of money to transfer, with two decimal precision

bankdataobject

Optional arbitrary data the bank can attach to the object

chips_ssnstring

Optional value for Chips SSN

counterparty_idstring

ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.

errorstring

Error message describing why a wire failed

idstring

Unique identifier for object

instructionsstring

Optional instructions for the recipient (maximum of 140 characters)

org_idstring

ID of the organization with which this object is associated. Filterable.

purposestring

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)

statusstring

One of pending, canceled, error, or sent. Filterable.

target_currency_codestring

Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.

uetrstring

Optional Unique End-to-end Transaction Reference. A UUID that identifies the wire end-to-end, originating from ISO 20022 processing

userdataobject

Optional arbitrary data the user can attach to the object

Changes

No recorded changes to this endpoint across all 1 revision of this API.