Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Create Device

Copy

Copied

curl https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd/devices \
    -H "Content-Type: application/json" \
    -H 'Finix-Version: 2022-02-01' \
    -u  USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3 \
  -d '
    {
      "configuration": {
        "allow_debit": true,
        "prompt_signature": "NEVER"
      },
      "description": "John Smith",
      "model": "MX915",
      "name": "Finix  triPOS #1"
    }'

HTTP Request

POST https://finix.sandbox-payments-api.com/merchants/:MERCHANT_ID/devices

URL Parameters

Field	Type	Description
:MERCHANT_ID	string, required	ID of Merchant

Request Arguments

Field	Type	Description
`description`	string, optional	Additional information about device (e.g. self serving terminal)
`model`	string, required	Please select one of the following values which will let Finix know the type of device being used: BBPOS IPP320 IPP350 ISC250 ISC480 ISMP4 LANE_3000 MX915 MX925 ANDROID
`name`	string, required	Name of device
`tags`	object, optional	Key value pair for annotating custom metadata (e.g. order numbers)

Configuration Arguments

Field	Type	Description
`allow_debit`	boolean, optional	Sets whether device will allow debit by default or not (defaults to true)
`bypass_device_on_capture`	boolean, optional	Sets if the device will be used to capture `Authorizations`. The device is required to be connected if `bypass_device_on_capture` is set to false. (defaults to true).
`check_for_duplicate_transactions`	boolean, optional	Sets whether the device will check for duplicate transactions
`prompt_amount_confirmation`	boolean, optional	Sets whether or not to make card holder confirm the amount they will pay (defaults is true)
`prompt_manual_entry`	boolean, optional	Sets whether or not the default card input method will be keyed in manual entry or not (defaults to false)
`prompt_signature`	string, optional	Sets whether device will prompt the card holder for a signature by default or not, AMOUNT is used in conjuction with signature_threshold_amount so that when the threshold is reached the signature form appears on device screen (defaults to always). Options are: ALWAYS, NEVER, AMOUNT
`signature_threshold_amount`	integer, optional	Threshold set for when to prompt a signature prompt_signature is set to AMOUNT (defaults to 0)

Copy

Copied

{
  "id" : "DVxoNJYTFdUD8i2NXgcerdUt",
  "created_at" : "2022-10-07T19:03:09.550868Z",
  "updated_at" : "2022-10-07T19:03:09.550868Z",
  "configuration_details" : {
    "allow_debit" : true,
    "check_for_duplicate_transactions" : true,
    "prompt_amount_confirmation" : true,
    "prompt_manual_entry" : false,
    "prompt_signature" : "NEVER",
    "signature_threshold_amount" : 0,
    "bypass_device_on_capture" : true
  },
  "description" : "John Smith",
  "enabled" : true,
  "idle_message" : null,
  "merchant" : "MUu56ZGx3Xb6U9gAqKfgNisd",
  "model" : "MX915",
  "name" : "Finix  triPOS #1",
  "serial_number" : null,
  "tags" : { },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/devices/DVxoNJYTFdUD8i2NXgcerdUt"
    },
    "merchant" : {
      "href" : "https://finix.sandbox-payments-api.com/merchants/MUu56ZGx3Xb6U9gAqKfgNisd"
    },
    "transfers" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers"
    },
    "authorizations" : {
      "href" : "https://finix.sandbox-payments-api.com/authorizations"
    }
  }
}