v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Wires

List outgoing wires

Get paginated list of wires

get/wires

Query parameters

originating_account_idstring uuid

Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

The unique identifier of the originating account.

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

customer_idstring uuid

Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

The unique identifier of a customer.

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

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

Example:READY

receiving_account_idstring uuid

Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

The unique identifier of the receiving account.

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

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

{
  "wires": [
    {
      "amount": 10000,
      "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",
      "input_message_accountability_data": "10220318BANK0001123456",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "network": "fedwire",
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "return_data": {
        "reason_code": "NARR"
      },
      "sender_reference_id": "9F564A6124E65",
      "settlement_date": "2022-03-18",
      "status": "PENDING",
      "status_details": "PENDING_DUAL_APPROVAL",
      "transaction_in_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96"
    }
  ],
  "next_page_token": "a8937a0d"
}