CLclover
MERCHANTS

Get all devices provisioned to a merchant

Returns a list of all devices that are provisioned to the a merchant. This list can be viewed from the Setup App on the merchant's device or web dashboard (https://www.clover.com/setupapp/m/{mId}/devices).

get/v3/merchants/{mId}/devices

Request

  • Base URL
    https://apisandbox.dev.clover.com
  • URL
    https://apisandbox.dev.clover.com/v3/merchants/{mId}/devices
  • Auth
    HTTP bearer

Path parameters

mIdstring required

Merchant Id

Query parameters

filterstring

Filter fields: [serial, name, merchant.id, merchant.name, deviceTypeName, model, id, deleted_time, orderPrefix]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

idstring

Unique identifier

namestring

Name of the device (if entered)

modelstring
orderPrefixstring

A prefix that will be applied to order numbers. This is useful if the merchant and/or customer needs to track which device an order came from.

terminalIdstring

The merchant device's terminal Id. FD-IPG sets the merchant_device terminal Id for LATAM devices

terminalPrefixinteger
serialstring

The device's serial number.

buildNumberinteger
secureIdstring
buildType'ENG' | 'USER' | 'USERDEBUG'
cpuIdstring
imeistring

The IMEI of the device

imsistring

The IMSI of the SIM in the device (if present)

simIccidstring

The ICCID of the SIM in the device (if present)

deviceCertificatestring
pedCertificatestring
deviceTypeNamestring
productNamestring
pinDisabledboolean

Whether this device has PIN prompt disabled.

offlinePaymentsboolean
offlinePaymentsAllboolean
offlinePaymentsLimitinteger
offlinePaymentsPromptThresholdinteger
offlinePaymentsTotalPaymentsLimitinteger
offlinePaymentsLimitDefaultinteger
offlinePaymentsPromptThresholdDefaultinteger
offlinePaymentsTotalPaymentsLimitDefaultinteger
offlinePaymentsMaxLimitinteger
offlinePaymentsMaxTotalPaymentsLimitinteger
showOfflinePaymentsboolean
maxOfflineDaysinteger
allowStoreAndForwardboolean
bundleIndicatorstring

Changes

No recorded changes to this operation across all 2 revisions of this API.