Deprecated API Reference

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

Set Idle Message on Device

Copy

Copied

curl https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf \
-H "Content-Type: application/vnd.json+api" \
-H 'Finix-Version:2022-02-01' \
-u  USjHFGYvecE4LBitYG8KDE2g:b698f403-d9b7-4157-82d8-162cea8c8cc3 \
-X PUT \
-d '
  {
    "action": "CREATE_IDLE_MESSAGE",
    "idle_message": "Michaels Juice Shop"
  }'

HTTP Request

PUT https://finix.sandbox-payments-api.com/devices/:DEVICE_ID

URL Parameters

Field	Type	Description
:DEVICE_ID	string, required	ID of Device

Request Arguments

Field	Type	Description
`action`	string, required	The action parameter must include CREATE_IDLE_MESSAGE to create an idle message
`idle_message`	string, required	ID of Device

Copy

Copied

{
  "id" : "DVf2H8sh4LZZC52GTUrwCPPf",
  "created_at" : "2019-03-01T02:27:20.366Z",
  "updated_at" : "2022-04-05T18:48:40.383Z",
  "configuration_details" : {
    "allow_debit" : true,
    "check_for_duplicate_transactions" : true,
    "prompt_amount_confirmation" : false,
    "prompt_manual_entry" : true,
    "prompt_signature" : "AMOUNT",
    "signature_threshold_amount" : 10,
    "bypass_device_on_capture" : false
  },
  "description" : "John Smith",
  "enabled" : false,
  "idle_message" : null,
  "merchant" : "MUu56ZGx3Xb6U9gAqKfgNisd",
  "model" : "MX915",
  "name" : "Johns Juice Shop",
  "serial_number" : "343434343",
  "tags" : { },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/devices/DVf2H8sh4LZZC52GTUrwCPPf"
    },
    "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"
    }
  }
}