Card Reader & Payment Settings

Settings

Advanced Settings

JavaScript API Documentation

Swipe functionality returns the information from a card swipe directly to your HTML page through a JavaScript function. Your code would parse this information and submit it to a card processor to create a charge.


Card Reader Type

Kiosk Pro supports several magnetic stripe card readers:

Options:

  • IDTech UniMag II or Shuttle (audio jack connector)
  • IDTech iMag Pro (30-pin connector)
  • IDTech iMag Pro II (Lightning connector)
  • MagTek iDynamo (30-pin and Lightning connectors)

IDTech readers are available in both encrypted and unencrypted format. MagTek readers are only available as encrypted devices. More information on this is available here.

Links to API documentation and sample code for each reader is available here.


Swipe Request Settings

The following Swipe Request settings allow you to customize the alert shown on-screen while the app is waiting for a visitor to swipe a card.

Use of these settings requires that you call the ‘requestSwipe’ call for the reader you are using with the parameter ’**swipe_params_from_settings**'.

Swipe Timeout (seconds)

This setting allows you to configure how long the swipe request should run before timing out.

Swipe Request Text

This allows you to set the alert message that appears when asking for a visitor to swipe their card. The default alert is “Please swipe card.”

Use Custom Graphics for Swipe Request

This setting allows you to set up custom graphics for the alert that appears when asking for a visitor to swipe their card.

Once enabled, you must create your graphic and name it ‘mps-swipe-overlay-portrait.png’ or ‘mps-swipe-overlay-landscape.png’ depending on whether your kiosk head will be portrait or landscape (or create both if the iPad is able to be turned). In the Kiosk Pro documents folder, create a folder called ‘KioskAssets’ and place your files inside of this folder.

As Kiosk Pro is unable to detect whether the image file is for a low-resolution or a Retina screen, the size of the graphic you create should match the screen size of the device you are using.

Kiosk Pro will try to find the custom graphic file that matches your screen resolution, and if that size is unavailable, it will check for a smaller version:

Tablet Filename for Landscape Filename for Portrait
iPad Pro 12.9 mps-swipe-overlay-landscape@3x.png mps-swipe-overlay-portrait@3x.png
iPad 9.7" with Retina screen mps-swipe-overlay-landscape@2x.png mps-swipe-overlay-portrait@2x.png
iPad with non-retina screen mps-swipe-overlay-landscape.png mps-swipe-overlay-portrait.png

Hide Native App Swipe Requests

This setting allows you to hide the alert that appears when asking for a visitor to swipe their card.

As no special alert or graphic is shown on screen when this is enabled, your content must clearly explain to the visitor that they should swipe.


MercuryPay

Enable

This setting enables MercuryPay, which allows you to process secure, end-to-end encrypted credit card transactions within the United States.

Merchant ID

Your Merchant ID for MercuryPay System.

Web Services Password

Your password for MercuryPay System.

Server Request Timeout

This setting allows you to set how long the server should try to connect before it gives up on connecting. This setting must be an integer between 60 and 3900 (seconds).

Unique Kiosk Number

The Unique Kiosk Number is used as a prefix for invoice numbers, which ensures that invoice numbers are not duplicated across multiple kiosks.

This setting must be an integer between 1 and 999.

End of each time-initiated batching occurs daily at

This setting is for restarting daily invoice numbers. Once the time-based batching is initiated, closing the batch for that operation day, all invoice numbers are reset and it is no longer possible to rely on MercuryPay's duplicate processing prevention logic to prevent a double-charge to the card.

The format for this setting is ‘Hour Time Zone’. For example, “17 US/Eastern” would be 5 pm EST.

Automatically Print Standard Receipt

This setting allows you to print a standard receipt automatically when credit sale operation is finished.

Receipt Settings

These settings allow you to set the information that will be printed on the receipt. Options include:

  • Merchant Name
  • Street Address
  • City, State Zipcode
  • Phone
  • Refund/Return Policy

Still stuck? How can we help? How can we help?