Skip to main content
GET
List outgoing wires

Authorizations

Authorization
string
header
required

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

Query Parameters

originating_account_id
string<uuid>

The unique identifier of the originating account.

Example:

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

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

customer_id
string<uuid>

The unique identifier of a customer.

Example:

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

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"

receiving_account_id
string<uuid>

The unique identifier of the receiving account.

Example:

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

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

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 wires

wires
Wire · object[]
required

Array of 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"