v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Inbound Wire Transfers

get/inbound_wire_transfers

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Inbound Wire Transfers to ones belonging to the specified Account.

account_number_idstring

Filter Inbound Wire Transfers to ones belonging to the specified Account Number.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

status.instring[]

Filter Inbound Wire Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

wire_drawdown_request_idstring

Filter Inbound Wire Transfers to ones belonging to the specified Wire Drawdown Request.

Response

Inbound Wire Transfer List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "acceptance": {
        "accepted_at": "2020-01-31T23:59:59Z",
        "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
      },
      "account_id": "account_in71c4amph0vgo2qllky",
      "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "amount": 100,
      "created_at": "2020-01-31T23:59:59Z",
      "creditor_address_line1": "33 Liberty Street",
      "creditor_address_line2": "New York, NY, 10045",
      "creditor_address_line3": null,
      "creditor_name": "National Phonograph Company",
      "debtor_account_number": "987654321",
      "debtor_address_line1": "33 Liberty Street",
      "debtor_address_line2": "New York, NY, 10045",
      "debtor_address_line3": null,
      "debtor_name": "Ian Crease",
      "debtor_routing_number": "101050001",
      "description": "Inbound wire transfer",
      "end_to_end_identification": "Invoice 29582",
      "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
      "input_message_accountability_data": "20220118MMQFMP0P000001",
      "instructing_agent_routing_number": "101050001",
      "instruction_identification": "202201180000001",
      "purpose": "CASH",
      "reversal": null,
      "status": "accepted",
      "type": "inbound_wire_transfer",
      "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
      "unstructured_remittance_information": "INVOICE 2468",
      "wire_drawdown_request_id": null
    }
  ],
  "next_cursor": "v57w5d"
}