TapCardScanner-iOS

A SDK that provides an interface to scan different types of payment cards with various ways and contexts.

Requirements

To use the SDK the following requirements must be met:

1. Xcode 11.0 or newer
2. Swift 4.2 or newer (preinstalled with Xcode)
3. Deployment target SDK for the app: iOS 12.0 or later

Installation

Installation with CocoaPods

CocoaPods is a dependency manager, which automates and simplifies the process of using 3rd-party libraries in your projects. You can install it with the following command:

$ gem install cocoapods

Podfile

To integrate goSellSDK into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '12.0'
use_frameworks!

source 'https://github.com/CocoaPods/Specs.git'

target 'MyApp' do
    
    pod 'TapCardScanner-iOS'

end

Then, run the following command:

$ pod update

Features

TapCardScanner-iOS provides extensive ways for scanning payment cards whether:

• Embossed cards:

  • Cards that has digits and letters raised and well crafted.
  • Examples:
    • Visa.
    • Mastercard.
    • Amex.
    • 
  • For more info check : Embossed Card Explaination)

• Unembossed cards:

  • Cards where the numbers on the card are not raised up like a normal card. It is perfectly flat, with everything just printed on the card.
  • Examples:
    • Some types of Visa.
    • KNET in Kuwait.
    • MADA in KSA.
    • 

• For more info check: Unembossed Card Explaination.)

  Making it one of the most inclusive pods in the market, yet one of the easiest to integrate with.

Asynchronous Card Scanning

The kit provides an asyncronous offline way to scan cards from a camera feed right away in your app. This works great in case of scanning embossed cards. The Kit provides two ways to start an asynchronous:

1. Inline card scanner.
2. Full screen card scanner.
3. EMVCO push payment based QR codes.

Also, the Kit provides an interface to style the scanner in both cases as follows:

1. Cancel button color.
2. Cancel button localisation.
3. Scanner rectangle colour.

Asynchronous - Full Screen Scanner

This feature provides an easy way to start the scanner in a modal covering screen.

TapFullScreenUICustomizer Class

This class is used whenever you want to customise the look and feel of the full scanner.

Swift:

import TapCardScanner_iOS

let tapFullScreenCustomiser:TapFullScreenUICustomizer = TapFullScreenUICustomizer()
tapFullScreenCustomiser.tapFullScreenCancelButtonTitle = "Cancel"
tapFullScreenCustomiser.tapFullScreenCancelButtonFont = UIFont.systemFont(ofSize: 15)
tapFullScreenCustomiser.tapFullScreenCancelButtonTitleColor = .white
tapFullScreenCustomiser.tapFullScreenCancelButtonHolderViewColor = .black
tapFullScreenCustomiser.tapFullScreenScanBorderColor = .green

Parameters:

TapFullScreenCardScanner Class

This is the class providing the functionalioy of showing the Tap scanner as a modal full screen controller. Integrating with it is as simple as writing one line as follows

Swift:

import TapCardScanner_iOS

let fullScanner:TapFullScreenCardScanner = TapFullScreenCardScanner()

fullScanner.showModalScreen(presenter: self,tapCardScannerDidFinish: { (scannedCard) in
                            print("Card Number : \(scannedCard.tapCardNumber ?? "")\nCard Name : \(scannedCard.tapCardName ?? "")\nCard Expiry : \(scannedCard.tapCardExpiryMonth ?? "")/\(scannedCard.tapCardExpiryYear ?? "")\n")
                        },scannerUICustomization: customiser)

Parameters:

TapCard Class

This is the data model the scanner will return after scanning a card

Parameters:

Asynchronous - Inline Screen Scanner

This feature provides an easy way to add tap card scanner as a part of your UI by embedding it in a UIView

TapInlineCardScanner Class

This is the class providing the functionalioy of showing an inline scanner as a part of a given layout by bounding itself to a certain UIView.

Swift:

import TapCardScanner_iOS

let tapInlineScanner:TapInlineCardScanner = .init()
tapInlineScanner.startScanning(in: previewView,cardScanned: { (scannedCard) in
    print("Card Number : \(scannedCard.tapCardNumber ?? "")\nCard Name : \(scannedCard.tapCardName ?? "")\nCard Expiry : \(scannedCard.tapCardExpiryMonth ?? "")/\(scannedCard.tapCardExpiryYear ?? "")\n")
})

Parameters:

Synchronous Scanner

This feature provides an easy way to start a synchrnous scanning which scans card details from a given static image. This is to be used whenever you want to scan unembossed cards

TapInlineCardScanner Class

This class provides an interface to scan card details from a static image as follows:

Swift:

import TapCardScanner_iOS

let staticInlineScanner:TapInlineCardScanner = .init()
staticInlineScanner.ScanCard(from: imageWithCard)

Parameters: