GET
/
wire
List Wire Transfers
curl --request GET \
  --url https://api.treasuryprime.com/wire \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "account_id": "acct_1234567890",
      "amount": "10300.00",
      "counterparty_id": "cp_0987654321",
      "created_at": "2017-11-02T11:55:14Z",
      "error": null,
      "id": "wire_1029384756",
      "imad": {
        "parsed": {
          "cycle_date": "20220719",
          "input_sequence_number": "999999",
          "input_source": "ABCDEFG"
        },
        "unparsed": "20220719ABCDEFG999999"
      },
      "instructions": null,
      "intermediary": null,
      "omad": {
        "parsed": {
          "cycle_date": "20220719",
          "frb_application_id": "FT01",
          "output_date": "0102",
          "output_destination": "MMQFMPTQ",
          "output_sequence_number": "000106",
          "output_time": "1030"
        },
        "unparsed": "20170102MMQFMPTQ00010601021030FT01"
      },
      "status": "pending",
      "updated_at": "2017-11-02T11:55:14Z",
      "userdata": null
    }
  ]
}

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.

The response is of type object.