Device Transaction Request Options

Details the available options when sending a Device Transaction Request to a Device. These are all optional. If any aren't supplied, the specified default values will be sent to the Device automatically during a Device Transaction Request.

Properties

PropertyTypeDescriptionExample
allow_swipeBooleanToggles whether the device can accept swipe as a payment method input mode for this transaction request.false
allow_chipBooleanToggles whether the device can accept contact chip as a payment method input mode for this transaction request.true
allow_tapBooleanToggles whether the device can accept contactless as a payment method input mode for this transaction request.true
allow_fallback_to_chipBooleanToggles whether the device may fallback to chip during applicable fallback scenarios. A value of false will prevent fallback to chip entirely.true
allow_fallback_to_swipeBooleanToggles whether the device may fallback to swipe during applicable fallback scenarios. A value of false will prevent fallback to swipe entirely.false
enable_merchant_receiptBooleanToggles whether the merchant receipt should be printed after the transaction on print-capable devices for this transaction. A value of false does not mean a merchant copy will not be printed as a signature CVM will supercede this toggle.false
require_signature_on_swipeBooleanToggles whether a merchant receipt with a signature line should be printed for the cardholder to sign after the transaction when the cardholder provided a swipe input payment method.false
enable_customer_receiptBooleanToggles whether the customer/cardholder receipt should be printed after the transaction for their record keeping purposes.false
ask_for_customer_receiptBooleanToggles whether a dialogue window appears on the device screen asking if a customer receipt should be printed for this transaction before the printing takes place. If enable_customer_receipt is false, this option will be ignored.false
enable_tipBooleanToggles whether tip functionalities should be available for this transaction. If false, all other tip-relevant fields are ignored.true
apply_tip_before_authBooleanToggles whether the tip amount is determined before or after the transaction occurs. If true, the tip amount is added to the total transaction amount by the cardholder through the pre-auth tip dialogue UI on the device's screen. If false, a merchant receipt with tip lines is forced to be printed and the tip amount must be specified there by the cardholder, and the merchant must retain the merchant receit for tip adjustment later.true
enable_custom_tipBooleanToggles whether custom tip amount entry is available on the pre-auth tip dialogue UI for this transaction. If apply_tip_before_auth is false, this option will be ignored.true
tip_percentage_optionsArray<Number> (float or integer)Allows for the specification of up to three custom tip percentage values (float) on the pre-auth tip dialogue UI. Any values are accepted as long as they are numbers. The device will automatically sort them in ascending order. If apply_tip_before_auth is false, this option will be ignored. Please note: For example, a value of 1 indicates a 100% tip option, whereas a value of 0.1 indicates a 10% tip option.[0.18, 0.2, 0.22]
timeoutNumber (integer)Specifies the duration in seconds that the device will await cardholder input before timing out the transaction request. The acceptable range is [20, 999] and the bounds are enfored automatically by the device.30

Example

{
  "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,
  "enable_custom_tip": false,
  "apply_tip_before_auth": false,
  "tip_percentage_options": [
    0.18,
    0.2,
    0.22
  ],
  "timeout": 30
}