GET
/
wires
/
incoming
List incoming wires
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/wires/incoming \
  --header 'Authorization: Bearer <token>'
{
  "next_page_token": "a8937a0d",
  "wires": [
    {
      "account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "amount": 10000,
      "bank_message": "<string>",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "decline_reason": "<string>",
      "effective_date": "2022-03-18",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "input_message_accountability_data": "10220318BANK0001123456",
      "is_return": true,
      "network": "fedwire",
      "originating_account_number": 1961234745,
      "receiver": {
        "account_number": 192178512,
        "address": {
          "address_line_1": "321 Main St",
          "address_line_2": "Apt 34",
          "city": "Chicago",
          "country_code": "US",
          "postal_code": "60622",
          "state": "IL"
        },
        "address_lines": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "address_line_3": "<string>"
        },
        "alternate_identifier": 123456789,
        "bank_name": "Synctera Bank",
        "identifier_type": "Demand Deposit Account Number",
        "name": "John Smith",
        "routing_number": 272479663
      },
      "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "receiving_account_number": 1961234745,
      "recipient_message": "<string>",
      "return_data": {
        "original_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "original_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "previous_message_id": "<string>",
        "reason": "<string>"
      },
      "return_reason": "<string>",
      "sender": {
        "account_number": 192178512,
        "address": {
          "address_line_1": "321 Main St",
          "address_line_2": "Apt 34",
          "city": "Chicago",
          "country_code": "US",
          "postal_code": "60622",
          "state": "IL"
        },
        "address_lines": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "address_line_3": "<string>"
        },
        "alternate_identifier": 123456789,
        "bank_name": "Synctera Bank",
        "identifier_type": "Demand Deposit Account Number",
        "name": "John Smith",
        "routing_number": 272479663
      },
      "sender_reference_id": "9F564A6124E65",
      "settlement_date": "2022-03-18",
      "status": "READY",
      "tenant": "abcdef_ghijkl",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type_subtype": "BASIC_FUNDS_TRANSFER"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
enum<string>

Optional query parameter that can be use to filter the list of returned wires by transfer status

Available options:
BLOCKED,
POSTED,
READY
Example:

"READY"

​
to_date
string<date>

Only display transactions with an effective date less than or equal to to_date

​
from_date
string<date>

Only display transactions with an effective date greater than from_date

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
id
string<uuid>[]

Unique resource identifier

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

Response

List of incoming wires

​
wires
Incoming Wire · object[]
required

Array of incoming wires

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"