Properties

Property	Type	Description	Example
`type`*	`String`	The type of device transaction. `"auth"` means an auth transaction is requested. `"sale"` means a sale transaction is requested (default). `"cancel"` is used to cancel a pending device transaction request.	`"sale"`
`amount`*	`Number`(float)	The required amount in dollars of the transaction being requested.	`1.07`
`lodging`	`Object`(Lodging object)	Contains all optional lodging information to associate with the Transaction	See Lodging Examples
`device_options`	`Object`(Device Transaction Request Options object)	Contains all optional controls to change the behavior of the Device during a Device Transaction on a per-transaction request basis.	See Device Transaction Request Options Example

Requirements

*Required for all Device Transactions Requests. type defaults to a value of "sale" if omitted.

Example

{
  "type": "sale",
  "amount": 1.07,
}

Example with Device Options

{
  "type": "sale",
  "amount": 1.07,
  "device_options": {
    "allow_swipe": false,
    "allow_chip": true,
    "allow_tap": true,
    "allow_fallback_to_chip": true,
    "allow_fallback_to_swipe": false,
    "enable_merchant_receipt": false,
    "require_signature_on_swipe": false,
    "enable_customer_receipt": false,
    "ask_for_customer_receipt": false,
    "enable_tip": true,
    "enable_custom_tip": true,
    "apply_tip_before_auth": true,
    "tip_percentage_options": [
      0.18,
      0.2,
      0.22
    ],
    "timeout": 30
  }
}

Example with Lodging (Hotel) and Device Options

{
  "type": "sale",
  "amount": 1.07,
  "lodging": {
    "charge_type": "hotel",
    "duration": 1,
    "check_in_date": "2026-01-01",
    "check_out_date": "2026-01-02",
    "room_rate": 12.34,
    "folio_number": "FOL-12345",
    "renter_name": "Firstname Lastname",
    "extra_charges": false,
    "is_advance_deposit": false,
    "is_no_show": false,
    "is_delayed_charge": false
  },
  "device_options": {
    "allow_swipe": false,
    "allow_chip": true,
    "allow_tap": true,
    "allow_fallback_to_chip": true,
    "allow_fallback_to_swipe": false,
    "enable_merchant_receipt": false,
    "require_signature_on_swipe": false,
    "enable_customer_receipt": false,
    "ask_for_customer_receipt": false,
    "enable_tip": false,
    "timeout": 30
  }
}

Example with Lodging (Restaurant / Gift Shop) and Device Options

{
  "type": "sale",
  "amount": 1.07,
  "lodging": {
    "charge_type": "restaurant",
    "renter_name": "Firstname Lastname",
    "extra_charges": false,
    "is_advance_deposit": false,
    "is_no_show": false,
    "is_delayed_charge": false
  },
  "device_options": {
    "allow_swipe": false,
    "allow_chip": true,
    "allow_tap": true,
    "allow_fallback_to_chip": true,
    "allow_fallback_to_swipe": false,
    "enable_merchant_receipt": false,
    "require_signature_on_swipe": false,
    "enable_customer_receipt": false,
    "ask_for_customer_receipt": false,
    "enable_tip": false,
    "timeout": 30
  }
}