Swipe API: What's Included

In this article

Our Swipe APIs allow you to accept magnetic stripe card swipes through a variety of card readers. If you are based in the US, this API also allows you to send fully-encrypted credit card swipes to MercuryPay for secure processing.

Swipe through an IDTech Card Reader

The API supports card reading with several IDTech card readers, including:

  • Shuttle and UniMag II, which connect via the headphone jack
  • iMag Pro, which connects via the 30-pin port on earlier iOS devices
  • iMag Pro II, which connects via the Lightning port on newer iOS devices

This API allows you to request a magnetic stripe card swipe, returning the data encoded on the card and/or results of the current swipe (success, fail, timeout, or cancel) to your JavaScript code. This API also supports checking the current connection state of the card reader.

IDTech readers are available in encrypted and unencrypted versions. Unencrypted readers can return a plain text string of the data encoded on the card and are appropriate for low-security applications such as check-in or loyalty cards. Encrypted readers can return either a masked or encoded string, which can only be decrypted with the private key associated with that reader.

View Documentation for Shuttle & UniMag II

View Documentation for iMag Pro & iMag Pro II

Swipe through a MagTek Card Reader

The API supports Magtekā€™s most popular magnetic stripe card reader, the iDynamo, which connects through the 30-pin or Lightning port and provides a pass-through port for device charging.

This allows you to request swiping of the card and returns the card's data back to your HTML page. You can also get different connection states of the card reader, and get different callbacks about results of swiping (success, fail, timeout, or cancel).

Magtek readers are only available as encrypted devices. These encrypted readers can return either a masked or encoded string, which can only be decrypted with the private key associated with that reader.

View Documentation & Sample Code

Send swipes to MercuryPay

Kiosk Pro Enterprise provides the ability to communicate with MercuryPay servers to process secure, end-to-end encrypted credit card transactions using a IDTech Shuttle or Magtek iDynamo card reader correctly keyed to MercuryPay's servers.

View Documentation & Sample Code

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