/v1/facilities/{facility_id}/terminals/syncAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --request POST \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/terminals/sync' \
--header "Authorization: Bearer $FACILY_API_KEY"Parameters
facility_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataTerminalSyncResponserequiredWhat one sync changed, plus the active devices afterwards.
Show data schema
addedintegerrequiredDevices the processor listed that Facily had not seen before.
deactivatedintegerrequiredDevices Facily knew that the processor no longer lists. They are deactivated, not deleted, so payments taken at them keep their history.
terminalsTerminalResponse[]requiredEvery active device after the sync.
Show terminals schema
facility_idstringrequiredThe 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
idstringrequiredFacily's identifier for this device. It is what a charge names.
Format: uuid
is_activebooleanrequiredFalse once the processor stops listing the device. An inactive device cannot be charged and is not returned by the list.
last_synced_atstring | nullWhen the processor's device list last mentioned this device.
Format: date-time
Show last_synced_at schema
string | nullWhen the processor's device list last mentioned this device.
Variant 1: string
stringVariant 2: null
nullnicknamestring | nullThe label the operator gave this till at the processor, for example Front desk.
Show nickname schema
string | nullThe label the operator gave this till at the processor, for example Front desk.
Variant 1: string
stringVariant 2: null
nullregister_idstringrequiredThe processor's own identifier for the device.
register_typestring | nullThe terminal family, for example dejavoo.
Show register_type schema
string | nullThe terminal family, for example dejavoo.
Variant 1: string
stringVariant 2: null
nullserialstring | nullThe device's hardware serial number.
Show serial schema
string | nullThe device's hardware serial number.
Variant 1: string
stringVariant 2: null
nullupdatedintegerrequiredDevices 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.
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired