List Outgoing Synctera Pay vendors

Get paginated list of Outgoing Synctera Pay vendors associated

🚧 Beta This is a Beta endpoint. Feedback from the community is welcome. Any breaking changes to this endpoint will be pre-announced.

GET /synctera_pay/vendors

List Outgoing Synctera Pay vendors

cURL

curl --request GET \
  --url https://api.synctera.com/v2/synctera_pay/vendors \
  --header 'Authorization: Bearer <token>'

200

{
  "vendors": [
    {
      "config": {
        "unique_reference_ids": true
      },
      "name": "Wise",
      "enabled": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "tenant_id": "abcdef_ghijkl",
      "description": "Wise is a financial technology company that provides international money transfer services."
    }
  ],
  "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

id · string<uuid>

Synctera Pay Vendor ID

enabled · boolean

Example:

true

name · string

The name of the Synctera Pay vendor.

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"

Response

200

application/json

List of Synctera Pay vendors

vendors · Synctera Pay Vendor Response · object[] · required

Array of vendors

Show child attributes

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"