Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Wire

List Wire Transfers

get/wire

Query parameters

account_idstring

ID of the Account originating the transfer. Filterable.

counterparty_idstring

ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.

org_idstring

ID of the organization with which this object is associated. Filterable.

statusstring

One of pending, canceled, error, or sent. Filterable.

page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

from_datestring

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_datestring

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

A dictionary with a data property that contains a list of up to page_size wire elements, starting after the wire described by page_cursor. If no more wires are available, the resulting list will be empty.