GET
/
synctera_pay
/
vendors
List Synctera Pay vendors
curl --request GET \
  --url https://api.synctera.com/v1/synctera_pay/vendors \
  --header 'Authorization: Bearer <token>'
{
  "vendors": [
    {
      "config": {
        "unique_reference_ids": true
      },
      "description": "Wise is a financial technology company that provides international money transfer services.",
      "name": "Wise",
      "enabled": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "tenant_id": "abcdef_ghijkl"
    }
  ],
  "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

​
name
string

The name of the Synctera Pay vendor.

​
id
string<uuid>

Synctera Pay Vendor ID

​
enabled
boolean

Whether the resource is enabled.

Example:

true

​
page_token
string

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

Example:

"a8937a0d"

​
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 Synctera Pay vendors

​
vendors
Synctera Pay Vendor Response · object[]
required

Array of vendors

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