FreedomPay Payment Device
Note
Review the following requirements before proceeding:
The Company must activate the FreedomPay service—for more information, see Add Company Services.
Add and/or activate the FreedomPay service for at least one (1) site within the Company—for more information, see Add Services to Sites.
→ → → → →
To define settings for a FreedomPay payment device:
From the upper-right of the Peripherals area, select New Peripheral.
From the Peripheral Type dropdown, select Payment.
From the Peripheral Schema dropdown, select Freedom Pay.
From the Connection Type dropdown, select FreedomPay SDK.
Select Continue.
From the Peripheral Type section, toggle Active to Active if the device is available for use at company sites.
From the Peripheral Configuration section, define the following:
Field
Description
Peripheral Name
Type a name for the device.
Payment Platform
From the dropdown, select the processing application used by the device.
Vendor
From the dropdown, select the vendor for the device.
Model
From the dropdown, select the device model.
Manual Card Entry
From the dropdown, select the preferred option. The selected option determines when the user is allowed to enter a payment account number from the device manually.
FreedomPay Terminal ID
Type the ID for the device provided by FreedomPay.
POS Floor Limit
Type the maximum currency amount the merchant agrees to accept in offline mode—the Parent Brand may set a predetermined default amount.
Setting the amount to 0 disables Store and Forward (SAF).
Max Days Allowed Offline
Type the maximum number of consecutive days the merchant agrees to process transactions in offline mode—default set to 5.
This setting implies that at least one (1) online transaction was successfully completed before Store and Forward (SAF) executes.
Show Tips Dialog
Toggle Yes to display the dialog for guest tips when processing a payment for an order.
When toggled Yes, additional fields are provided.
In each Tip Option field, type a tip percentage (%) value to provide as an option from the tips dialog. The default values are 15, 18, and 20.
Enable SAF
Toggle Yes if the device supports and the merchant allows Store and Forward (SAF) offline transaction processing.
SAF Port
Type the port number used for SAF offline transaction processing.
Enable DCC
Toggle Yes to allow Dynamic Currency Conversion (DCC), which enables the guest to select the desired currency from the payment entry device (PED) after entering the payment card.
Retry Count
Type the maximum number of attempts to retry processing a transaction using the Store and Forward (SAF) engine—default set to 100.
Days to Keep Failed Transactions
Type the number of days to retain failed transactions before deletion—default set to 30.
Failure Replay Timer
Type the interval (in minutes) to retry a failed replay attempt—default set to 5.
Valid value range: 5 - 60.
Decline Replay Timer
Type the interval (in minutes) to retry a declined replay attempt—default set to 1440.
Valid value range: 5 - 2147483647.
Reversal Queue Retry Limit
Type the maximum number of attempts to process a pending reversal before moving from the reversal queue to the Store and Forward (SAF) engine—default set to 3.
Device Configuration File Upload
Select the zip file to upload that contains contains the device configuration details—optional.
SDK Log Level
From the dropdown, select the desired SDK log level for the device.
Valid values: Info; Debug; Warn; Error; Fatal.
The default value is Info.
From the Connection Configuration section, define the following:
From the Connection Type dropdown, select FreedomPay SDK.
From the Adapter Type dropdown, select FreedomPay SDK.
From the Device Connection Subtype dropdown, select the connection type between the POS terminal and the FreedomPay device: either USB or LAN.
In the Serial Number field (USB only), type the device serial number.
In the IP field (LAN only), type the specific IP address of the FreedomPay device.
In the Port field (LAN only), type the COM port to which the device is connected—typically, all FreedomPay devices at the site use the same port.