---
title: "List incoming wires"
method: GET
path: "/wires/incoming"
tags: ["Wires"]
---

# List incoming wires

`GET /wires/incoming`

Get paginated list of incoming wires

## Query parameters

- `to_date` string, date
- `from_date` string, date
- `status` 'BLOCKED' | 'POSTED' | 'READY' — Optional query parameter that can be use to filter the list of returned wires by transfer status
- `imad` string — Optional query parameter to filter incoming wires by IMAD (Input Message Accountability Data)
- `omad` string — Optional query parameter to filter incoming wires by OMAD (Output Message Accountability Data)
- `page_token` string — Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
- `id` string[]
- `uetr` string, uuid — Optional query parameter to filter incoming wires by UETR (Unique End-to-End Transaction Reference)
- `limit` integer — Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

## Response `200`

List of incoming wires

- IncomingWireList
  - `next_page_token` string — If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.
  - `wires` IncomingWire[], required — Array of incoming wires
    - `amount` integer, required — Transfer amount in cents ($100 would be 10000)
    - `bank_message` string — Information from the sending bank to the receiving bank.
    - `creation_time` string, date-time, required
    - `currency` string — 3-character currency code
    - `customer_id` string, uuid — The customer UUID representing the person initiating the Wire transfer
    - `decline_reason` string — Description of any errors or problems encountered during processing.
    - `effective_date` string, date — The effective date of the transaction
    - `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.
    - `extracted_account_number` string — 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.
    - `id` string, uuid, required — wire ID
    - `input_message_accountability_data` string — The IMAD of the incoming wire. The field is called Message Identification in the ISO format.
    - `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.
    - `is_return` boolean, required — Indicates if the wire is a return of an outgoing wire
    - `network` string — The network used to process the wire
    - `originating_account_number` string, string — The account number of the sender, as provided in the wire file.
    - `receiver` Party, required — Information about a party in a wire transfer
      - `account_number` string — account number of the person
      - `address` Address3
        - `address_line_1` string — street address
        - `address_line_2` string — street address
        - `city` string — city
        - `country_code` string — country code
        - `postal_code` string — postal code
        - `state` string — state
      - `address_lines` AddressLines
        - `address_line_1` string — address line 1 from wire file
        - `address_line_2` string — address line 2 from wire file
        - `address_line_3` string — address line 3 from wire file
      - `alternate_identifier` string — alternate identifier of the party, used in place of account number
      - `bank_name` string — name of the bank this party is a member of
      - `identifier_type` string — type of value used to identify the party
      - `name` string — name of the person
      - `routing_number` string — routing number of the bank this person is a member of
    - `receiving_account_id` string, uuid — The internal Synctera account uuid representing the recipient of the wire.
    - `receiving_account_number` string, string, required — The account number of the recipient, as provided in the wire file.
    - `recipient_message` string — Information from the originator to the beneficiary (recipient).
    - `return_data` ReturnData1 — Data associated with a returned wire
      - `original_end_to_end_identification` string
      - `original_id` string, uuid — UUID of the original wire that was returned. This field is populated if the system successfully matches the return to an original wire.
      - `original_instruction_identification` string
      - `original_transaction_id` string, uuid — Ledger transaction UUID of the original wire that was returned. This field is populated if the system successfully matches the return to an original wire.
      - `original_transaction_identification` string
      - `original_uetr` string
      - `previous_message_id` string, required — IMAD of the original wire that was returned
      - `reason` string — Additional information regarding the cause of the return
      - `reason_code` string — The code associated with the return reason
    - `return_reason` string — The reason we are returning this wire.
    - `sender` Party, required — Information about a party in a wire transfer
      - `account_number` string — account number of the person
      - `address` Address3
        - `address_line_1` string — street address
        - `address_line_2` string — street address
        - `city` string — city
        - `country_code` string — country code
        - `postal_code` string — postal code
        - `state` string — state
      - `address_lines` AddressLines
        - `address_line_1` string — address line 1 from wire file
        - `address_line_2` string — address line 2 from wire file
        - `address_line_3` string — address line 3 from wire file
      - `alternate_identifier` string — alternate identifier of the party, used in place of account number
      - `bank_name` string — name of the bank this party is a member of
      - `identifier_type` string — type of value used to identify the party
      - `name` string — name of the person
      - `routing_number` string — routing number of the bank this person is a member of
    - `sender_reference_id` string, required — Sender's id associated with fedwire transfer
    - `settlement_date` string, date — The settlement date of the transaction
    - `status` 'BLOCKED' | 'POSTED' | 'READY' | 'RETURNED', required — The current status of the transfer
    - `tenant` string, required — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `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` 'BASIC_FUNDS_TRANSFER' | 'PRIOR_DAY_TRANSFER_REVERSAL' | 'RETURN' | 'SAME_DAY_TRANSFER_REVERSAL' — The fedwire label associated with the subtype code
    - `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.

## Other responses

- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/versions/b0d812e6cdd0/schema)