Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsSync Terminals
Search the full API reference Esc to close

Sync Terminals

Payments · REST API reference

Get support
POST/v1/facilities/{facility_id}/terminals/sync
Re-read the merchant's own device list and make the registry match (spec 13).

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/terminals/sync' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

facility_idpath · stringrequired

Format: uuid

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "added": 0,
    "deactivated": 0,
    "terminals": [
      {
        "facility_id": "00000000-0000-4000-8000-000000000001",
        "id": "00000000-0000-4000-8000-000000000001",
        "is_active": false,
        "register_id": "string",
        "last_synced_at": "2026-10-29T12:00:00Z",
        "nickname": "string",
        "register_type": "string",
        "serial": "string"
      }
    ],
    "updated": 0
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataTerminalSyncResponserequired

What one sync changed, plus the active devices afterwards.

Show data schema
addedintegerrequired

Devices the processor listed that Facily had not seen before.

deactivatedintegerrequired

Devices Facily knew that the processor no longer lists. They are deactivated, not deleted, so payments taken at them keep their history.

terminalsTerminalResponse[]required

Every active device after the sync.

Show terminals schema
facility_idstringrequired

The facility that first synced this device. Under one merchant shared by several facilities it is a record of where the device was found, not a restriction on who may use it.

Format: uuid

idstringrequired

Facily's identifier for this device. It is what a charge names.

Format: uuid

is_activebooleanrequired

False once the processor stops listing the device. An inactive device cannot be charged and is not returned by the list.

last_synced_atstring | null

When the processor's device list last mentioned this device.

Format: date-time

Show last_synced_at schema
string | null

When the processor's device list last mentioned this device.

Variant 1: string
string
Variant 2: null
null
nicknamestring | null

The label the operator gave this till at the processor, for example Front desk.

Show nickname schema
string | null

The label the operator gave this till at the processor, for example Front desk.

Variant 1: string
string
Variant 2: null
null
register_idstringrequired

The processor's own identifier for the device.

register_typestring | null

The terminal family, for example dejavoo.

Show register_type schema
string | null

The terminal family, for example dejavoo.

Variant 1: string
string
Variant 2: null
null
serialstring | null

The device's hardware serial number.

Show serial schema
string | null

The device's hardware serial number.

Variant 1: string
string
Variant 2: null
null
updatedintegerrequired

Devices Facily already knew that the processor still lists, and so confirmed. Their label, serial and family are re-read from the processor on every sync, so this counts every device confirmed, not only the ones whose details changed.

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll payments operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Sync Terminals | Facily Developers