GET
/
synctera_pay
Get Synctera Pay Transfers
curl --request GET \
  --url https://api.synctera.com/v1/synctera_pay \
  --header 'Authorization: Bearer <token>'
{
  "transfers": [
    {
      "customer_id": "46fec39e-e776-4571-bf90-d0e1d15172fe",
      "destination_account_id": "fccb4a46-1261-4e91-b622-73b5b946183d",
      "destination_account_owner_name": "<string>",
      "effective_date": "2022-03-18",
      "failed": false,
      "history": [
        {
          "data": {},
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_same_day": true,
      "network_status": "POSTED",
      "original_reference_id": "<string>",
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "originating_account_owner_name": "<string>",
      "posting_date": "2022-03-18",
      "reference_id": "<string>",
      "status": "POSTED",
      "suspended": false,
      "tenant_id": "abcdef_ghijkl",
      "transaction_id": "45b5246f-ad97-4629-9aac-465b74a05505",
      "amount": 10000,
      "configuration_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "currency": "USD",
      "dc_sign": "DEBIT",
      "direction": "OUTGOING",
      "exchange_details": {
        "fees": [
          {
            "amount": 2,
            "currency": "<string>",
            "description": "<string>",
            "fee_type": "FX",
            "percentage": "<string>"
          }
        ],
        "rate": 1.30445,
        "source_amount": 10000,
        "source_currency": "USD",
        "target_amount": 10000,
        "target_currency": "GBP"
      },
      "final_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_data": {},
      "subtype": "OUTGOING_INTERNATIONAL_REMITTANCE",
      "synctera_pay_network": "WISE",
      "synctera_pay_vendor_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
max_amount
integer

Query transfers with at most this amount in minor units (ie cents)

Required range: x >= 1
Example:

100

​
subtype
string

Subtype of the transfer

​
from_posting_date
string

From posting date of the transfer

​
to_posting_date
string

To posting date of the transfer

​
id
string<uuid>

Synctera Pay Transfer ID

​
amount
string

Query transfers with the exact amount in minor units (ie cents)

Example:

100

​
reference_id
string

Reference ID of the transfer

​
effective_date
string

Effective date of the transfer

​
min_amount
integer

Query transfers with at least this amount in minor units (ie cents)

Required range: x >= 1
Example:

100

​
is_same_day
boolean

Is same day transfer

​
originating_account_id
string<uuid>

Originating account ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
from_effective_date
string

From effective date of the transfer

​
customer_id
string<uuid>

Customer ID of the transfer

​
originating_account_owner_name
string

Originating account owner name

​
to_effective_date
string

To effective date of the transfer

​
dc_sign
string

DC sign of the transfer

​
currency
string

Currency of the transfer

Example:

"USD"

​
network_status
string

Network status of the transfer

​
status
string

Status of the transfer

​
posting_date
string

Posting date of the transfer

​
destination_account_id
string<uuid>

Destination account ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
destination_account_owner_name
string

Destination account owner name

Example:

"Jane Joe"

Response

Retrieve all Synctera Pay transfers

​
transfers
Outgoing Synctera Pay Transfer Response · object[]
required

Array of transfers.

​
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"