QuickSale EMV Payment Application Side-by-Side Integration Guide for iPhone … · 2018. 10....

21
QuickSale EMV Payment Application Side-by-Side Integration Guide for iPhone v1.3 Document ID: CAMP iPhone SBS Guide Document Version: 1.3 Prepared for: CHARGE Anywhere ® 4041B Hadley Rd South Plainfield, NJ 07080 Phone + 1 (800) 211-1256 Fax + 1 (732) 417-4448 Date prepared: October 23, 2018 Notice This document contains confidential, trade secret information, which is proprietary to Charge Anywhere (“Charge Anywhere ® ”) and is provided solely for the recipients use in connection with recipient’s participation in one of Charge Anywhere’s Programs. Charge Anywhere reserves the right to make changes to the specifications at any time and without notice. The information furnished by Charge Anywhere in this publication is believed to be accurate and reliable as of the date of its release; however, no responsibility is assumed by Charge Anywhere for its use, nor for infringements of patents or other rights of third parties resulting from its use, nor for the violation, misinterpretation, of misapplication of any laws, or any regulation of any credit card association including but not limited to Visa Inc. or MasterCard Worldwide. No general license is granted under any patents, copyrights or other intellectual property rights owned by Charge Anywhere and the recipient is only granted an end user license to use this information for the purpose of participating in one of Charge Anywhere’s Programs, pursuant to an agreement with Charge Anywhere or one of its authorized Program partners. All modifications or improvements to any of the information and specifications in this document shall belong exclusively to Charge Anywhere. No unauthorized copying, disclosure, or use of this document is permitted without the express written consent of Charge Anywhere. Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

Transcript of QuickSale EMV Payment Application Side-by-Side Integration Guide for iPhone … · 2018. 10....

  • QuickSale EMV Payment Application Side-by-Side Integration Guide for

    iPhone v1.3

    Document ID: CAMP iPhone SBS Guide

    Document Version: 1.3

    Prepared for: CHARGE Anywhere

    ®

    4041B Hadley Rd

    South Plainfield, NJ 07080

    Phone + 1 (800) 211-1256

    Fax + 1 (732) 417-4448

    Date prepared: October 23, 2018

    Notice

    This document contains confidential, trade secret information, which is proprietary to Charge Anywhere (“Charge Anywhere®”) and is provided solely for the recipients use in connection with recipient’s participation in one of Charge Anywhere’s Programs. Charge Anywhere reserves the right to make changes to the specifications at any time and without notice. The information furnished by Charge Anywhere in this publication is believed to be accurate and reliable as of the date of its release; however, no responsibility is assumed by Charge Anywhere for its use, nor for infringements of patents or other rights of third parties resulting from its use, nor for the violation, misinterpretation, of misapplication of any laws, or any regulation of any credit card association including but not limited to Visa Inc. or MasterCard Worldwide. No general license is granted under any patents, copyrights or other intellectual property rights owned by Charge Anywhere and the recipient is only granted an end user license to use this information for the purpose of participating in one of Charge Anywhere’s Programs, pursuant to an agreement with Charge Anywhere or one of its authorized Program partners. All modifications or improvements to any of the information and specifications in this document shall belong exclusively to Charge Anywhere. No unauthorized copying, disclosure, or use of this document is permitted without the express written consent of Charge Anywhere.

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • Contents

    1 Download QuickSale App from App Store ................................................................................... 1

    2 Welcome and Registration ........................................................................................................... 2

    3 User Profile Creation .................................................................................................................... 3

    4 User Login .................................................................................................................................... 4

    5 Connect to Peripheral devices (Swiper and Printer) .................................................................... 5

    5.1 Go to Settings -> Bluetooth on iPhone. Turn Bluetooth On. .......................................... 5

    5.2 Open the QuickSale Payment Application from the Main Screen and Select Config -> Setup -> Peripheral Devices ............................................................................................................ 6

    5.3 From Peripheral Device, Select Swiper. Select the device from the available list to connect. Select ‘Back’ and go to Main Screen. ................................................................................ 7

    6 Process Test Transactions ........................................................................................................... 8

    7 Create Regular User .................................................................................................................... 9

    8 Initiating the QuickSale Payment Application from an External Application to process a

    Payment.........................................................................................................................................10

    8.1 Use the following URL format to initiate Chargeanywhere App .....................................10

    8.2 Processing Payments from Sale Screen....................................................................... 10

    9 Receiving data into an External application from the QuickSale Payment Application................ 11

    9.1 Data from QuickSale App can be received by implementing the following Scheme “ChargeanywhereTransactionResult:\\?” ........................................................................................ 11

    9.2 XCode Configuration to implement “ChargeanywhereTransactionResult:\\?” Scheme. 12

    9.3 Sample Code to get the result from Chargeanywhere. …............................................. 13

    10 Steps to Process a Payment through the QuickSale Payment Application from an External Application ...................................................................................................................................... 14

    10.1 Collect the amount and payment type (Sale/Return) from your App. ......................... 14

    10.2 QuickSale App opens the Scale Screen and receives the Credit Card Information using connected POS device. …………………………………………………………………..15

    10.3 Press Actions - > Submit ............................................................................................ 16

    10.4 The Signature Screen will be displayed. The Customer will Sign and then Press ‘Submit’ ...………………………………………………………………….................................. 18

    10.5 Certain data elements including the Amount, last four digits of the truncated card number, Approval code and processor response message are passed back by the QuickSale Payment Application to the external application................................................ 19

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 1 DOWNLOAD QUICKSALE APP FROM APP STORE

    - Enter App Store on iPhone or Computer - Search for “QuickSale” - Press “Install”

    For computer download, iPhone needs to be synced to PC for App transfer to phone

    1

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 2 DOWNLOAD QUICKSALE APP FROM APP STORE Enter License Number and Phone Number. Press Submit To request a demo license go to http://corporate.chargeanywhere.com/contact-us/

    2

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

    http://corporate.chargeanywhere.com/contact-us/

  • 3 USER PROFILE CREATION

    Enter Password, Clerk # (not required), Security Question, Security Answer and Email to create User Profile. Press “Save”.

    The initial User will have “admin” as the user name. Immediately, once logged into the application as admin, create a new user profile which will avoid admin user logout. Create a new user name and password by going to Config – Security – User Management – Add User and complete the profile by reviewing the User permissions. Do not use the admin user name since it has a short user timeout setting and it will automatically log you out every 15 minutes.

    3

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 4 USER LOGIN

    Enter User name and Password. Press ‘Submit’

    4

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 5 CONNECT TO PERIPHERAL DEVICES (SWIPER AND PRINTER)

    5.1 Go to Settings -> Bluetooth on iPhone. Turn Bluetooth On.

    In your iPhone device settings pair with the external peripheral device as suggested by device manufacturer.

    5

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 5.2 Open the QuickSale Payment Application from the Main Screen and Select Config -> Setup -> Peripheral Devices

    6

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 5.3 From Peripheral Device, Select Swiper. Select the device from the available list to connect. Select ‘Back’ and go to Main Screen.

    7

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 6 PROCESS TEST TRANSACTIONS EMV Card - Insert Chip card into connected peripheral device. - Enter Amount. Press Actions -> Submit. Follow the instructions on the screen.

    Magnetic Swipe / PIN Debit

    - Swipe a card from connected peripheral device. - Enter Amount. Press Actions -> Submit. Follow the instructions on the screen.

    8

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 7 CREATE REGULAR USER - Login to app

    - Config > Security > User Management > Add User

    - Do not change any permissions for this user

    Use this user for the Side by Side Integration to avoid user timeouts.

    9

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 8 INITIATING THE QUICKSALE PAYMENT APPLICATION FROM AN EXTERNAL APPLICATION TO PROCESS A PAYMENT.

    8.1 Use the following URL format to initiate Chargeanywhere App

    ChargeanywhereProcessTransaction://?transactionType=1&saleAmount=amt

    Parameter description:

    Name Type Description

    transactionType String 1 – Sale

    6 - Return

    saleAmmount String The amount to be processed by QuickSale App.

    invoiceNumber String The invoiceNumber to be used for this transaction.

    clerkNumber String The clerkNumber to be used for this transaction.

    customerNumber String The customerNumber to be used for this transaction.

    Sample Code:

    NSMutableString *customURL =

    [NSMutableString stringWithString:@"ChargeanywhereProcessTransaction://?"];

    if ([[UIApplication sharedApplication] canOpenURL:[NSURL URLWithString:customURL]])

    {

    [customURL appendFormat:@"%@=%@&", @”transactionType”, @"1"];

    [customURL appendFormat:@"%@=%@&", @”saleAmount”, @”1.00”]

    [[UIApplication sharedApplication] openURL:[NSURL URLWithString:customURL]];

    }

    8.2 Processing Payments from Sale Screen.

    The URL “ ChargeanywhereProcessTransaction://?transactionType=1&saleAmount=amt

    “ opens the Sale screen on Chargeanywhere App.

    Enter Credit card information and press ‘Actions’ -> Submit

    If connected to external Swiper, Swipe/Insert the Chip card into the connected peripheral device. Follow the instructions on the App.

    10

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 9 RECEIVING DATA INTO AN EXTERNAL APPLICATION FROM THE QUICKSALE PAYMENT APPLICATION.

    9.1 Data from Chargeanywhere App can be received by implementing the following Scheme

    “ChargeanywhereTransactionResult:\\?”

    Response when payment is Approved:

    "ChargeanywhereTransactionResult://?CardNumber=**********1004& CardHolderName=Test&Response=APPROVED& ResponseCode=000&TransactionId=900000123&ApprovalCode=114250& ProcessReferenceNumber=989998&CVVResponse=y& AVSResponse=y&TransactionType=Sale&AuthorizedAmt=1.00”

    Response when Payment is Declined/Payment is cancelled:

    "ChargeanywhereTransactionResult://?TransactionResult=TransactionCancelled”

    Parameter Description:

    Name Type Description

    cardNumber String Truncated Card Number

    cardHolderName String Card Holder Name (if available)

    responseCode String Three digit Response Code Returned by Gateway

    processorResponseCode String Response Code Returned by Processor

    responseText String Response Text

    avsResponse Char One character AVS Response (if available)

    cvvResponse Char One character CVV Response (if available)

    approvalCode String One character CVV Response (if available)

    transactionId String 9 digit Transaction ID

    gatewayReferenceNumber String Reference Number (if available) returned by Gateway

    processReferenceNumber String Reference Number (if available) returned by Processor

    authorizedAmount String Amount authorized by Gateway

    11

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 9.2 XCode Configuration to implement “ChargeanywhereTransactionResult:\\?” Scheme. In the XCode Project, Select Project -> Info Under “Info”, Select “URL Types” drop down, Add the new URL Type by Selecting ‘+’

    Enter the following information for new URL Type.

    Identifier: com.chargeanywhere.transactionResult

    URL Schemes: ChargeanywhereTransactionResult

    12

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 9.3 Sample Code to get the result from Chargeanywhere. File: AppDelegate.m

    Add the Code to method in AppDelegate

    - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url

    sourceApplication:(NSString *)sourceApplication annotation:(id)annotation

    {

    NSLog(@"Calling Application Bundle ID: %@", sourceApplication);

    NSLog(@"URL scheme:%@", [url scheme]);

    NSLog(@"URL query: %@", [url query]);

    if ([[url scheme] isEqualToString:@"ChargeanywhereTransactionResult"])

    {

    NSLog(@"Chargeanywhere Transaction Result: %@", [url query]); // Process the result

    }

    return YES;

    }

    13

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 10 STEPS TO PROCESS A PAYMENT THROUGH THE QUICKSALE PAYMENT APPLICATION FROM AN EXTERNAL APPLICATION

    10.1 Collect the amount and payment type (Sale/Return) from your App.

    14

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 10.2 QuickSale App opens the Scale Screen and receives the Credit Card Information using connected POS device.

    15

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 10.3 Press Actions - > Submit

    16

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • The Payment is submitted by the QuickSale Payment Application. If the transaction is APPROVED, APPROVED message is displayed with approval code. Press OK.

    17

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 10.4 The Signature Screen will be displayed. The Customer will Sign and then Press ‘Submit’

    18

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.

  • 10.5 Certain data elements including the Amount, last four digits of the truncated card number, Approval code and processor response message are passed back by the QuickSale Payment Application to the external application.

    19

    Confidential. All rights reserved. Copyright 2017 Charge Anywhere, LLC.