Skip to main content
GET
List incoming wires

Authorizations

Authorization
string
header
required

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

Query Parameters

to_date
string<date>

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

from_date
string<date>

Only display transactions with an effective date greater than from_date

status
enum<string>

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

Available options:
BLOCKED,
POSTED,
READY
Example:

"READY"

imad
string

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

Example:

"20250715B6B7HU2R012486"

omad
string

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

Example:

"20250715MMQFMP2300021707151048FT03"

page_token
string

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

Example:

"a8937a0d"

id
string<uuid>[]

Unique resource identifier

uetr
string<uuid>

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

Example:

"5be434c4-f2c2-4f1f-8900-09c5c9d4e2d3"

limit
integer
default:100

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

Required range: x >= 1
Example:

100

Response

List of incoming wires

wires
Incoming Wire · object[]
required

Array of incoming wires

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.

Example:

"a8937a0d"