Skip to main content
GET
/
incoming_wire
List Incoming Wires
curl --request GET \
  --url https://api.treasuryprime.com/incoming_wire \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "account_id": "<string>",
      "amount": "<string>",
      "bank_id": "<string>",
      "beneficiary": {
        "address": [
          "<string>"
        ],
        "bank_data": {
          "account_number": "<string>",
          "account_type": "<string>",
          "address": [
            "<string>"
          ],
          "bank_name": "<string>",
          "routing_number": "<string>"
        },
        "name": "<string>"
      },
      "id": "<string>",
      "imad": {
        "parsed": {
          "cycle_date": "<string>",
          "input_sequence_number": "<string>",
          "input_source": "<string>"
        },
        "unparsed": "<string>"
      },
      "org_id": "<string>",
      "originator": {
        "address": [
          "<string>"
        ],
        "bank_data": {
          "account_number": "<string>",
          "account_type": "<string>",
          "address": [
            "<string>"
          ],
          "bank_name": "<string>",
          "routing_number": "<string>"
        },
        "name": "<string>"
      },
      "originator_to_beneficiary_info": "<string>",
      "received_at": "<string>",
      "status": "<string>",
      "transaction_id": "<string>",
      "wire_body": {}
    }
  ]
}

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 receiving the transfer. Filterable.

​
org_id
string

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

​
status
string

One of pending processing done failed, or returned. Filterable.

​
transaction_id
string

ID of the associated transaction. 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 incoming_wire elements, starting after the incoming_wire described by page_cursor. If no more incoming_wires are available, the resulting list will be empty.

​
data
object[]