Introduction

The CardPointe Desktop SDK enables you to quickly and easily integrate secure payment card tokenization and card-present payments using the CardPointe Desktop (ID TECH Augusta) card reader device.

This guide provides information to help you integrate the CardPointe Desktop solution with your application.

Overview

The CardPointe Desktop SDK integration consists of the following components:

See the CardPointe Desktop Integration Guide, below, for more information.

CardPointe Desktop Card Reader

The CardPointe Desktop card reader device (ID TECH Augusta) is an EMV (chip) and MSR (magnetic stripe) card reader device that offers a simple upgrade path to EMV from traditional countertop magnetic stripe readers. The device encrypts card data at the point of interaction, ensuring that sensitive cardholder data is never exposed to your environment. Additionally, the device supports EMV Quick Chip, allowing you to accept EMV payments much more quickly than standard EMV.

See the CardPointe Desktop Device User's Guide for information on using and troubleshooting the device.

The device uses keyboard emulation to output the encrypted card data string from the device into a field, as though you manually typed the string into the field using your keyboard.

The CardPointe Desktop card reader is preconfigured with the following required settings:

  • USB Keyboard (KB) Mode - This setting enables the device to act as a keyboard, returning data to your application as though it was typed on a keyboard.
  • Quick Chip and M/Chip Fast Transaction Mode - This setting enables the the device to read EMV cards in Quick Chip mode and automatically output the data to your application.
  • Auto Mode - This setting enables the device to automatically output track data for MSR card reads to your application.

These settings are required for the CardPointe Desktop solution to function as designed, and must not be modified. 

CardPointe Desktop Integration Guide

The CardPointe Desktop solution supports the following integration methods, providing flexible tokenization and payment functions to your application.

  • CardSecure API - Integrate the CardPointe Desktop device and CardSecure API with your application to capture and tokenize encrypted MSR track or EMV tag data.
  • Hosted iFrame Tokenizer - Integrate the Hosted iFrame Tokenizer and CardPointe Desktop device with your web application, to easily capture and tokenize card data using the secure iFrame.
  • CardPointe Gateway API - Use the CardPointe Gateway API to authorize payments using the tokens you generate from the CardSecure API or Hosted iFrame Tokenizer. Alternatively, streamline your integration by using the CardPointe Desktop device to capture track data to pass in an authorization request. The response returns a token to your application, as well as the transaction details.

Requirements

To integrate the CardPointe Desktop solution with your application, you must meet the following requirements:

  • You must have a CardPointe merchant account.
  • Your merchant account must be boarded to the First Data Rapid Connect processor.
  • You must have a CardPointe Desktop (ID TECH Augusta) card reader device, pre-provisioned and provided for use with your merchant account.

Printing Receipts

If you use the CardPointe Desktop solution to accept payments, you will need to provide your customers with either print or digital receipts. To do so, you can retrieve certain data from the authorization response to print on the receipt. See Printing Receipts Using Authorization Data for detailed information.

Sample Tokenization Requests

You can use the CardSecure API to tokenize track data captured using the CardPointe Desktop device. The following examples illustrate sample tokenization requests using track data captured by the device.

MethodURLRequest Header
POSThttps://{site}.cardconnect.com/cardsecure/api/v1/ccn/tokenizeContent-Type: application/json

The CardPointe Desktop device uses keyboard emulation to output the track data to your application.

To capture the track data output, put your cursor in the devicedata field in the request body, then insert or swipe the card at the device. The device retrieves and encrypts the track data and inserts it at the cursor.

Sample Authorization Requests

You can use the CardPointe Gateway API to authorize a payment either using a token returned by CardSecure or the Hosted iFrame Tokenizer, or by directly sending the track data captured by the device in the track field in the request.

The following examples illustrate sample authorization requests using the tokenized and raw track data from the CardPointe Desktop device.

MethodURLRequest Header
POST or PUThttps://{site}.cardconnect.com/cardconnect/rest/authContent-Type: application/json
Authorization: Basic