List Wire Transfers

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

account_id

string

ID of the Account originating the transfer. Filterable.

counterparty_id

string

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

org_id

string

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

status

string

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

page_cursor

string

Pagination cursor, value is the object ID.

page_size

integer

default:100

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

Required range: x >= 1

from_date

string

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

to_date

string

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

Response

200 - application/json

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.

data

object[]

Show child attributes

data.account_id

string

ID of the Account originating the transfer. Filterable.

data.amount

string

Amount of money to transfer, with two decimal precision

data.bankdata

object

Optional arbitrary data the bank can attach to the object

data.chips_ssn

string

Optional value for Chips SSN

data.counterparty_id

string

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

data.error

string

Error message describing why a wire failed

data.fx_quote

object

Associated foreign exchange quote, if any. Only present for wires at some bank partners.

data.id

string

Unique identifier for object

data.imad

object

Optional Input Message Accountability Data. An ID often filled out by the banks, originating from fed processing

Show child attributes

data.imad.parsed

object

Parsed IMAD sub-object

Show child attributes

data.imad.parsed.cycle_date

string

Wire transfer date. YYYYMMDD

data.imad.parsed.input_sequence_number

string

A 6 digit number assigned for uniqueness

data.imad.parsed.input_source

string

8 Alpha or Alpha-Numeric characters identifying the source

data.imad.unparsed

string

Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService

data.instructions

string

Optional instructions for the recipient (maximum of 140 characters)

data.intermediary

object

Optional intermediary bank information. If the recipient's bank is unable to receive a wire transfer, they will use an intermediary bank to process the wire

Show child attributes

data.intermediary.address

object

Physical address of the bank

Show child attributes

data.intermediary.address.city

string

City (max 18 characters)

data.intermediary.address.country

string

Country (ISO 3166-1 alpha-2). Defaults to US

data.intermediary.address.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

data.intermediary.address.state

string

State (max 2 characters for US, max 3 characters for other countries)

data.intermediary.address.street_line_1

string

First line of the address (max 35 characters)

data.intermediary.address.street_line_2

string

Optional second line of the address (max 35 characters)

data.intermediary.name

string

Name of the bank (maximum of 35 characters)

data.intermediary.routing_number

string

Valid 9-digit ABA routing transit number associated with the bank

data.omad

object

Optional Output Message Accountability Data. An ID originating from fed processing, similar structure to IMAD but with more info

Show child attributes

data.omad.parsed

object

Parsed OMAD sub-object

Show child attributes

data.omad.parsed.cycle_date

string

Wire transfer date. YYYYMMDD

data.omad.parsed.frb_application_id

string

Uniquely identifies the Fedwire Funds Service site that processed the message (i.e., FT01, FT02 or FT03)

data.omad.parsed.output_date

string

4 digit MMDD. Paired with output_time

data.omad.parsed.output_destination

string

8 Alpha or Alpha-Numeric characters identifying the destination. Comparable to the IMAD input_source

data.omad.parsed.output_sequence_number

string

A 6 digit number assigned for uniqueness. Comparable to IMAD input_sequence_number

data.omad.parsed.output_time

string

4 digit HHmm. Paired with output_date

data.omad.unparsed

string

Output Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService

data.org_id

string

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

data.purpose

string

Optional string identifying the reason for why these funds are being transferred. For example Payroll, Tuition, Travel, etc. Required if sending an international wire (maximum of 16 characters)

data.status

string

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

data.target_currency_code

string

Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.

data.userdata

object

Optional arbitrary data the user can attach to the object

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Query Parameters

Response