PATCH
/
wires
/
incoming
/
{wire_id}
Update an incoming wire by id
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/wires/incoming/{wire_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  }
}'
{
  "amount": 10000,
  "bank_message": "<string>",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "decline_reason": "<string>",
  "effective_date": "2022-03-18",
  "end_to_end_identification": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_message_accountability_data": "10220318BANK0001123456",
  "instruction_identification": "<string>",
  "is_return": true,
  "network": "fedwire",
  "originating_account_number": 1961234745,
  "receiver": {
    "account_number": 192178512,
    "address": {
      "address_line_1": "321 Main St",
      "address_line_2": "Apt 34",
      "city": "Chicago",
      "country_code": "US",
      "postal_code": "60622",
      "state": "IL"
    },
    "address_lines": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>"
    },
    "alternate_identifier": 123456789,
    "bank_name": "Synctera Bank",
    "identifier_type": "Demand Deposit Account Number",
    "name": "John Smith",
    "routing_number": 272479663
  },
  "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"
  },
  "return_reason": "<string>",
  "sender": {
    "account_number": 192178512,
    "address": {
      "address_line_1": "321 Main St",
      "address_line_2": "Apt 34",
      "city": "Chicago",
      "country_code": "US",
      "postal_code": "60622",
      "state": "IL"
    },
    "address_lines": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>"
    },
    "alternate_identifier": 123456789,
    "bank_name": "Synctera Bank",
    "identifier_type": "Demand Deposit Account Number",
    "name": "John Smith",
    "routing_number": 272479663
  },
  "sender_reference_id": "9F564A6124E65",
  "settlement_date": "2022-03-18",
  "status": "READY",
  "tenant": "abcdef_ghijkl",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transaction_identification": "<string>",
  "type_subtype": "BASIC_FUNDS_TRANSFER",
  "uetr": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
wire_id
string<uuid>
required

The unique identifier of a wire transfer.

Example:

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

Body

application/json

Patch incoming wire request

Patch object for incoming wire

​
return_data
object

Data associated with a returned wire

Response

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"

​
id
string<uuid>
required

wire ID

​
is_return
boolean
required

Indicates if the wire is a return of an outgoing wire

​
receiver
object
required

Information about a party in a wire transfer

​
receiving_account_number
string<string>
required

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

Example:

1961234745

​
sender
object
required

Information about a party in a wire transfer

​
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:
BLOCKED,
POSTED,
READY,
RETURNED
Example:

"READY"

​
tenant
string
required

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

Example:

"abcdef_ghijkl"

​
bank_message
string

Information from the sending bank to the receiving bank.

​
currency
string

3-character currency code

Example:

"USD"

​
customer_id
string<uuid>

The customer UUID representing the person initiating the Wire transfer

Example:

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

​
decline_reason
string

Description of any errors or problems encountered during processing.

​
effective_date
string<date>

The effective date of the transaction

Example:

"2022-03-18"

​
end_to_end_identification
string

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.

​
input_message_accountability_data
string

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

Example:

"10220318BANK0001123456"

​
instruction_identification
string

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.

​
network
string

The network used to process the wire

Example:

"fedwire"

​
originating_account_number
string<string>

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

Example:

1961234745

​
receiving_account_id
string<uuid>

The internal Synctera 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

​
return_reason
string

The reason we are returning this wire.

​
settlement_date
string<date>

The settlement date of the transaction

Example:

"2022-03-18"

​
transaction_id
string<uuid>

ID of the resulting transaction resource

​
transaction_identification
string

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
enum<string>

The fedwire label associated with the subtype code

Available options:
BASIC_FUNDS_TRANSFER,
PRIOR_DAY_TRANSFER_REVERSAL,
RETURN,
SAME_DAY_TRANSFER_REVERSAL
Example:

"BASIC_FUNDS_TRANSFER"

​
uetr
string<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.