API: Return Magnetic Stripe Card Data from Swipe

kp_UniMag2CardReader_requestStateOfSupporting();
		

kp_iMagCardReader_requestStateOfSupporting();
		

kp_iDynamoCardReader_requestDeviceType();
		

kp_UniMag2CardReader_requestStateOfConnection();
		

kp_iMagCardReader_requestStateOfConnection();
		

kp_iDynamoCardReader_requestStateOfConnection();
		

kp_UniMag2CardReader_requestSwipe(swipeInfo);
		

• swipeInfo - [array] defining how the swipe alert should be shown. If a key-value pair is absent, then Kiosk Pro will use the default value shown for that pair. If swipe parameters are empty or contain errors (for example, missing the closing quotes), then Kiosk Pro will not use swipe parameters and will use only default values for all keys. Possible keys and default values are:
• title - [string] the title of the native iOS alert shown during the swipe request. Defaults to "Swipe Request"
• message - [string] the message of the native iOS alert shown during the swipe request. Defaults to "Please swipe card."
• cancelButtonTitle - [string] the cancel button text of the native iOS alert shown during the swipe request. Defaults to "Cancel"
• timeout - [integer] the timeout duration of the swipe request in seconds. Defaults to 20
• OR '**swipe_params_from_settings**', which triggers the app to use the Swipe Timeout and Swipe Request Text defined in the app's settings

kp_UniMag2CardReader_requestSwipe('"title":"titleValue","timeout":20');
		

kp_UniMag2CardReader_requestSwipe('**swipe_params_from_settings**');
		

Kiosk Pro will trigger one of the following depending on the result of the card swipe request:

• kp_UniMag2CardReader_swipeDidFinishWithTransactionDataEx
• kp_UniMag2CardReader_swipeDidFailWithError
• kp_UniMag2CardReader_swipeDidFinishWithTimeout
• kp_UniMag2CardReader_swipeDidCancel

kp_iMagCardReader_requestSwipe(swipeInfo);
		

• swipeInfo - [array] defining how the swipe alert should be shown. If a key-value pair is absent, then Kiosk Pro will use the default value shown for that pair. If swipe parameters are empty or contain errors (for example, missing the closing quotes), then Kiosk Pro will not use swipe parameters and will use only default values for all keys. Possible keys and default values are:
• title - [string] the title of the native iOS alert shown during the swipe request. Defaults to "Swipe Request"
• message - [string] the message of the native iOS alert shown during the swipe request. Defaults to "Please swipe card."
• cancelButtonTitle - [string] the cancel button text of the native iOS alert shown during the swipe request. Defaults to "Cancel"
• timeout - [integer] the timeout duration of the swipe request in seconds. Defaults to 20
• OR '**swipe_params_from_settings**', which triggers the app to use the Swipe Timeout and Swipe Request Text defined in the app's settings

kp_iMagCardReader_requestSwipe('"title":"titleValue","timeout":20');
		

kp_iMagCardReader_requestSwipe('**swipe_params_from_settings**');
		

Kiosk Pro will trigger one of the following depending on the result of the card swipe request:

• kp_iMagCardReader_swipeDidFinishWithData
• kp_iMagCardReader_swipeDidFailWithError
• kp_iMagCardReader_swipeDidFinishWithTimeout
• kp_iMagCardReader_swipeDidCancel

kp_iDynamoCardReader_requestSwipe(swipeInfo);
		

• swipeInfo - [array] defining how the swipe alert should be shown. If a key-value pair is absent, then Kiosk Pro will use the default value shown for that pair. If swipe parameters are empty or contain errors (for example, missing the closing quotes), then Kiosk Pro will not use swipe parameters and will use only default values for all keys. Possible keys and default values are:
• title - [string] the title of the native iOS alert shown during the swipe request. Defaults to "Swipe Request"
• message - [string] the message of the native iOS alert shown during the swipe request. Defaults to "Please swipe card."
• cancelButtonTitle - [string] the cancel button text of the native iOS alert shown during the swipe request. Defaults to "Cancel"
• timeout - [integer] the timeout duration of the swipe request in seconds. Defaults to 20
• OR '**swipe_params_from_settings**', which triggers the app to use the Swipe Timeout and Swipe Request Text defined in the app's settings

kp_iDynamoCardReader_requestSwipe('"title":"titleValue","timeout":20');
		

kp_iDynamoCardReader_requestSwipe('**swipe_params_from_settings**');
		

Kiosk Pro will trigger one of the following depending on the result of the card swipe request:

• kp_iDynamoCardReader_swipeDidFinishWithData
• kp_iDynamoCardReader_swipeDidFailWithError
• kp_iDynamoCardReader_swipeDidFinishWithTimeout
• kp_iDynamoCardReader_swipeDidCancel

kp_UniMag2CardReader_cancelSwipe();
		

Kiosk Pro will immediately trigger kp_UniMag2CardReader_swipeDidCancel

kp_iMagCardReader_cancelSwipe();
		

Kiosk Pro will immediately trigger kp_iMagCardReader_swipeDidCancel

kp_iDynamoCardReader_cancelSwipe();
		

Kiosk Pro will immediately trigger kp_iDynamoCardReader_swipeDidCancel

kp_UniMag2CardReader_stateOfSupportingDidChange(supported);
		

• supported - [integer] representing whether the Card Reader Type is set to 'ID Tech Shuttle or UniMag II' in Kiosk Pro's settings. Possible values are:
• 1 - Card Reader Type is set to 'ID Tech Shuttle or UniMag II' in Kiosk Pro's settings
• 0 - Card Reader Type is not set to 'ID Tech Shuttle or UniMag II' in Kiosk Pro's settings

kp_iMagCardReader_stateOfSupportingDidChange(supported);
		

• supported - [integer] representing whether the Card Reader Type is set to 'ID Tech iMag Pro or iMag Pro II' in Kiosk Pro's settings. Possible values are:
• 1 - Card Reader Type is set to 'ID Tech iMag Pro or iMag Pro II' in Kiosk Pro's settings
• 0 - Card Reader Type is not set to 'ID Tech iMag Pro or iMag Pro II' in Kiosk Pro's settings

kp_iDynamoCardReader_deviceTypeDidChange(deviceType);
		

• deviceType - [integer] representing whether the Card Reader Type is set to 'MagTek iDynamo' in Kiosk Pro's settings. Possible values are:
• 0 - Card Reader Type is set to 'MagTek iDynamo' in Kiosk Pro's settings
• 2 - Card Reader Type is not set to 'MagTek iDynamo' in Kiosk Pro's settings

kp_UniMag2CardReader_connectionStateDidChange(state);
		

• state - [integer] representing the current connection state of the card reader. Possible values include:
• 0 - disconnected
• 1 - connecting and attempting to power card reader
• 2 - connected
• 3 - timeout while attempting to connect, meaning that the reader was unable to meet its power requirements and/or the connection process failed. The user should remove the card reader, insert the reader again, and check that headphone volume is set to maximum level

kp_iMagCardReader_connectionStateDidChange(state);
		

• state - [integer] representing the current connection state of the card reader. Possible values include:
• 0 - disconnected
• 1 - connecting and attempting to power card reader
• 2 - connected
• 3 - timeout while attempting to connect, meaning that the reader was unable to meet its power requirements and/or the connection process failed. The user should remove the card reader and insert the reader again

kp_iDynamoCardReader_connectionStateDidChange(state);
		

• state - [integer] representing the current connection state of the card reader. Possible values include:
• 0 - disconnected
• 1 - connecting and attempting to power card reader
• 2 - connected
• 3 - timeout while attempting to connect, meaning that the reader was unable to meet its power requirements and/or the connection process failed. The user should remove the card reader and insert the reader again

kp_UniMag2CardReader_swipeDidFinishWithTransactionDataEx(cardData);
		

• cardData - [array] representing data encoded on the card that has been swiped. Formatted as an associative array of key-value pairs with the following keys:
• card_type - [integer] representing the card type. Possible values are: 128 means type, otherwise other card type.
• 128 - ISO/ABA card (standard credit/debit card)
• 131 - other card type
• t1_mask_data - [string, can be empty] the unencrypted data on track 1, which may contain masked * characters if the reader is configured for encryption
• t1_encrypted_data - [string, can be empty] the encrypted data on track 1
• t2_mask_data - [string, can be empty] the unencrypted data on track 2, which may contain masked * characters if the reader is configured for encryption
• t2_encrypted_data - [string, can be empty] the encrypted data on track 2
• t3_mask_data - [string, can be empty] the unencrypted data on track 3, which may contain masked * characters if the reader is configured for encryption
• t3_encrypted_data - [string, can be empty] the encrypted data on track 3
• ksn - [string, can be empty] the key serial number
• dsn - [string, can be empty] the device serial number
• account_number - [string, can be empty] the credit/debit card number, which may contain masked * characters if the reader is configured for encryption
• card_holder_name - [string, can be empty] the card holder's name
• expiration_date - [string, can be empty] the expiration date associated with the credit/debit card in the format 'YY/MM'.

kp_iMagCardReader_swipeDidFinishWithData(track1Text, track2Text);
		

• track1Text - [string, can be empty] the unencrypted data on track 1, which may contain masked * characters if the reader is configured for encryption
• track2Text - [string, can be empty] the unencrypted data on track 2, which may contain masked * characters if the reader is configured for encryption

kp_iDynamoCardReader_swipeDidFinishWithData(track1Masked, track1Encrypted, track2Masked, track2Encrypted, account_number, card_holder_name, expiration_date);
		

• track1Masked - [string, can be empty] the unencrypted, masked data on track 1
• track1Encrypted - [string, can be empty] the encrypted data on track 1
• track2Masked - [string, can be empty] the unencrypted, masked data on track 2
• track2Encrypted - [string, can be empty] the encrypted data on track 2
• account_number - [string, can be empty] the unencrypted, masked card account number
• card_holder_name - [string, can be empty] the unencrypted card holder's name
• expiration_date - [string, can be empty] the unencrypted card expiration date

kp_UniMag2CardReader_swipeDidFailWithError(errorCode);
		

• errorCode - [integer] representing the type of error that occurred. Possible values are:
• -1001 - the card reader is not enabled in Kiosk Pro's settings
• -1000 - a card swipe has already been requested and is currently pending
• 1 - unreadable swipe (for example, the magnetic stripe on the card has been corrupted or poor swiping technique was used)

kp_iMagCardReader_swipeDidFailWithError(errorCode);
		

• errorCode - [integer] representing the type of error that occurred. Possible values are:
• -1001 - the card reader is not enabled in Kiosk Pro's settings
• -1000 - a card swipe has already been requested and is currently pending
• 1 - unreadable swipe (for example, the magnetic stripe on the card has been corrupted or poor swiping technique was used)

kp_iDynamoCardReader_swipeDidFailWithError(error);
		

• error - [array] representing the type of error that occurred. Formatted as an associative array of key-value pairs with the following keys:
• -1001 - the card reader is not enabled in Kiosk Pro's settings
• domain - [string] the type of error being returned.  This will always return 'KPIDynamoCardReaderSwipeErrorDomain'
• code - [integer] the numeric code associated with the specific error. For example, '4', which is associated with a bad swipe
• description - [string] a text string describing the specific error being returned for use in troubleshooting. For example, "IDynamo Card Reader - bad swipe (track error)"

kp_UniMag2CardReader_swipeDidFinishWithTimeout();
		

kp_iMagCardReader_swipeDidFinishWithTimeout();
		

kp_iDynamoCardReader_swipeDidFinishWithTimeout();
		

kp_UniMag2CardReader_swipeDidCancel();
		

kp_iMagCardReader_swipeDidCancel();
		

kp_iDynamoCardReader_swipeDidCancel();