Skip to main content
GET
/
synctera_pay
/
incoming
/
transfers
List Incoming Synctera Pay Transfers
curl --request GET \
  --url https://api.synctera.com/v2/synctera_pay/incoming/transfers
{
  "transfers": [
    {
      "amount": 2,
      "configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_data": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "payee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference_id": "<string>",
      "settlement_date": "2023-12-25",
      "source_external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "CREATE_HOLD",
      "tenant": "abcdef_ghijkl",
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
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

​
page_token
string

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

Example:

"a8937a0d"

​
amount
integer[]
​
config_id
string<uuid>[]
​
destination_account_id
string<uuid>[]
​
from_amount
integer
​
from_creation_time
string<date-time>
​
from_last_updated_time
string<date-time>
​
from_settlement_date
string<date>
​
id
string<uuid>[]
​
payee_id
string<uuid>[]
​
payer_id
string<uuid>[]
​
reference_id
string[]
​
settlement_date
string<date>
​
sort_by
enum<string>[]
​
source_external_account_id
string<uuid>[]
​
tenant
string[]

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

​
to_amount
integer
​
to_creation_time
string<date-time>
​
to_last_updated_time
string<date-time>
​
to_settlement_date
string<date>

Response

list of matching Incoming Synctera Pay transfers

​
transfers
object[]
required
​
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"