PATCH
/
wires
/
{wire_id}
Cancel an outgoing wire
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/wires/{wire_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "CANCELED"
}'
{
  "amount": 10000,
  "bank_message": "<string>",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_message_accountability_data": "10220318BANK0001123456",
  "is_bulk": true,
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "network": "fedwire",
  "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "originating_account_number": 1961234745,
  "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "receiving_account_number": 1961234745,
  "recipient_message": "<string>",
  "return_data": {
    "original_end_to_end_identification": "<string>",
    "original_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "original_instruction_identification": "<string>",
    "original_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "original_transaction_identification": "<string>",
    "original_uetr": "<string>",
    "previous_message_id": "<string>",
    "reason": "<string>",
    "reason_code": "NARR"
  },
  "sender_reference_id": "9F564A6124E65",
  "settlement_date": "2022-03-18",
  "status": "PENDING",
  "status_details": "PENDING_DUAL_APPROVAL",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transaction_in_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96"
}

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"

Path Parameters

​
wire_id
string<uuid>
required

The unique identifier of a wire transfer.

Example:

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

Body

application/json

wire to update

​
status
enum<string>
required

Field value must be set to CANCELED. It can only be changed when status is PENDING.

Available options:
CANCELED
Example:

"CANCELED"

Response

Updated 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"

​
fed_input_message_accountability_data
string

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.

Example:

"10220318BANK0001123456"

​
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

​
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"