v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Wires

List incoming wires

Get paginated list of incoming wires

get/wires/incoming

Query parameters

to_datestring date

Only display transactions with an effective date less than or equal to to_date

from_datestring date

Only display transactions with an effective date greater than from_date

status'BLOCKED' | 'POSTED' | 'READY'

Optional query parameter that can be use to filter the list of returned wires by transfer status

Example:READY

imadstring

Optional query parameter to filter incoming wires by IMAD (Input Message Accountability Data)

Example:20250715B6B7HU2R012486

omadstring

Optional query parameter to filter incoming wires by OMAD (Output Message Accountability Data)

Example:20250715MMQFMP2300021707151048FT03

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

idstring[]

Unique resource identifier

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]

uetrstring uuid

Optional query parameter to filter incoming wires by UETR (Unique End-to-End Transaction Reference)

Example:5be434c4-f2c2-4f1f-8900-09c5c9d4e2d3

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

Response

List of incoming wires

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "next_page_token": "a8937a0d",
  "wires": [
    {
      "amount": 10000,
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "effective_date": "2022-03-18",
      "extracted_account_number": "1961234745",
      "input_message_accountability_data": "10220318BANK0001123456",
      "network": "fedwire",
      "receiver": {
        "address": {
          "address_line_1": "321 Main St",
          "address_line_2": "Apt 34",
          "city": "Chicago",
          "country_code": "US",
          "postal_code": "60622",
          "state": "IL"
        },
        "bank_name": "Synctera Bank",
        "identifier_type": "Demand Deposit Account Number",
        "name": "John Smith"
      },
      "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "return_data": {
        "reason_code": "NARR"
      },
      "sender": {
        "address": {
          "address_line_1": "321 Main St",
          "address_line_2": "Apt 34",
          "city": "Chicago",
          "country_code": "US",
          "postal_code": "60622",
          "state": "IL"
        },
        "bank_name": "Synctera Bank",
        "identifier_type": "Demand Deposit Account Number",
        "name": "John Smith"
      },
      "sender_reference_id": "9F564A6124E65",
      "settlement_date": "2022-03-18",
      "status": "READY",
      "tenant": "abcdef_ghijkl",
      "type_subtype": "BASIC_FUNDS_TRANSFER"
    }
  ]
}