Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Devices

Create a Merchant Device

Create a Device under a Merchant.

post/merchants/{merchant_id}/devices

Path parameters

merchant_idstring required

The ID of the Merchant the Device will be created under.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

descriptionstring

Additional information about device (e.g. self serving terminal).

integration_mode'PAYMENT_APP' | 'SDK'

Defines the operating mode of the Device. PAYMENT_APP devices operate within the standard Finix ecosystem. SDK devices are for customers who are building their own PAX app.

model'PAX_A800' | 'PAX_A920PRO' | 'PAX_D135' | 'PAX_IM30' required

The model type of the Device.

namestring required

Name of the Device.

serial_numberstring required

The serial number of the Device.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Response

Request to create a device under a merchant.

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

android_versionstring

The Android version installed on the Device.

descriptionstring nullable

Additional information about device (e.g. self serving terminal).

enabledboolean

Whether the Device is enabled. false indicates disabled.

firmware_versionstring

The current version of the device's firmware.

idle_messagestring nullable

Sets the idle message text on the terminal. This is what will be presented on the welcome screen. FINIX_V1 and DUMMY_V1 only.

idle_image_file_idstring nullable

The ID of the file to be displayed on the device when it is idle. Passing a value of null resets the device's idle image to the default.

integration_mode'PAYMENT_APP' | 'SDK'

Defines the operating mode of the Device. PAYMENT_APP devices operate within the standard Finix ecosystem. SDK devices are for customers who are building their own PAX app.

merchantstring

ID of the Merchant resource.

model'PAX_A800' | 'PAX_A920PRO' | 'PAX_D135' | 'PAX_IM30'

The model type of the Device.

namestring

The display name of the Device used for filtering purposes.

payment_app_versionstring

The device’s current app version.

prompt_signature'ALWAYS'

When to prompt for a signature.

serial_numberstring nullable

The serial_number is a unique identifier for the Device, located on the back and typically composed of ~16 digits. Ensure the serial number is set before activating the Device, though it can also be added later using a PUT request.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Example response

{
  "merchant": "MUxxxxxxxxxxxxxxxxxx"
}