IDTech iOS SDK Guide  1.1.097
API reference for BTPayMini
IDT_BTPayMini.h
1 //
2 // IDT_BTPayMini.h
3 // IDTech
4 //
5 // Created by Randy Palermo on 10/29/14.
6 // Copyright (c) 2014 IDTech Products. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #import "IDTMSRData.h"
11 #import "IDT_Device.h"
12 
14 @protocol IDT_BTPayMini_Delegate <NSObject>
15 @optional
16 -(void) deviceConnected;
17 -(void) deviceDisconnected;
18 - (void) dataInOutMonitor:(NSData*)data incoming:(BOOL)isIncoming;
19 
24 - (void) swipeMSRData:(IDTMSRData*)cardData;
25 
27 - (void) deviceMessage:(NSString*)message;
28 
30 
31 
32 
46 - (void) lcdDisplay:(int)mode lines:(NSArray*)lines;
47 
60 - (void) emvTransactionData:(IDTEMVData*)emvData errorCode:(int)error;
61 
62 @end
63 
67 @interface IDT_BTPayMini : NSObject<IDT_Device_Delegate>{
68  id<IDT_BTPayMini_Delegate> delegate;
69 }
70 
71 @property(strong) id<IDT_BTPayMini_Delegate> delegate;
72 
73 
74 
82 +(NSString*) SDK_version;
83 
92 
97 -(void) close;
98 
99 
100 
101 
102 
109 -(RETURN_CODE) ctls_cancelTransaction;
110 
111 
112 
113 
114 
127 -(RETURN_CODE) ctls_getConfigurationGroup:(int)group response:(NSDictionary**)response;
128 
129 
130 
131 
141 -(RETURN_CODE) ctls_removeAllCAPK;
142 
153 -(RETURN_CODE) ctls_removeApplicationData:(NSString*)AID;
154 
165 -(RETURN_CODE) ctls_removeCAPK:(NSData*)capk;
166 
177 -(RETURN_CODE) ctls_removeConfigurationGroup:(int)group;
178 
179 
190 -(RETURN_CODE) ctls_retrieveAIDList:(NSArray**)response;
191 
202 -(RETURN_CODE) ctls_retrieveApplicationData:(NSString*)AID response:(NSDictionary**)response;
203 
221 -(RETURN_CODE) ctls_retrieveCAPK:(NSData*)capk key:(NSData**)key;
222 
223 
233 -(RETURN_CODE) ctls_retrieveCAPKList:(NSArray**)keys;
234 
247 -(RETURN_CODE) ctls_retrieveTerminalData:(NSData**)tlv;
248 
264 -(RETURN_CODE) ctls_setApplicationData:(NSData*)tlv;
265 
283 -(RETURN_CODE) ctls_setCAPK:(NSData*)key;
284 
285 
299 -(RETURN_CODE) ctls_setConfigurationGroup:(NSData*)tlv;
300 
301 
315 -(RETURN_CODE) ctls_setTerminalData:(NSData*)tlv;
316 
317 
318 
319 
368 -(RETURN_CODE) ctls_startTransaction:(double)amount type:(int)type timeout:(int)timeout tags:(NSMutableDictionary *)tags;
369 
370 
371 
384 -(RETURN_CODE) ctls_startTransaction;
385 
386 
387 
388 
389 
390 
409 -(RETURN_CODE) device_getFirmwareVersion:(NSString**)response;
410 
411 
430 -(bool) device_enableBLEDeviceSearch:(NSUUID*)identifier;
431 
432 
433 
441 -(NSString*) device_getBLEFriendlyName;
442 
443 
451 -(void) device_setBLEFriendlyName:(NSString*)friendlyName;
452 
453 
464 
472 -(NSUUID*) device_connectedBLEDevice;
473 
474 
484 -(RETURN_CODE) device_getAutoPollTransactionResults:(IDTEMVData**)result;
485 
498 -(NSString *) device_getResponseCodeString: (int) errorCode;
499 
515 -(bool) device_isConnected:(IDT_DEVICE_Types)device;
516 
530 -(RETURN_CODE) device_sendIDGCommand:(unsigned char)command subCommand:(unsigned char)subCommand data:(NSData*)data response:(NSData**)response;
531 
532 
533 
553 -(RETURN_CODE) device_setPassThrough:(BOOL)enablePassThrough;
554 
565 -(RETURN_CODE) device_setBurstMode:(int) mode;
566 
567 
578 -(RETURN_CODE) device_setPollMode:(int) mode;
579 
597 -(RETURN_CODE) device_startRKI;
598 
624 -(RETURN_CODE) emv_authenticateTransaction:(NSData*)tags;
641 -(RETURN_CODE) emv_callbackResponseLCD:(int)mode selection:(unsigned char) selection;
642 
643 
644 
687 -(RETURN_CODE) emv_completeOnlineEMVTransaction:(BOOL)isSuccess hostResponseTags:(NSData*)tags;
688 
689 
690 
699 -(void) emv_disableAutoAuthenticateTransaction:(BOOL)disable;
700 
701 
702 
721 -(RETURN_CODE) emv_getEMVL2Version:(NSString**)response;
722 
742 -(RETURN_CODE) emv_removeApplicationData:(NSString*)AID;
743 
764 -(RETURN_CODE) emv_removeCAPK:(NSString*)rid index:(NSString*)index ;
765 
766 
767 
768 
786 -(RETURN_CODE) emv_removeCRLList;
787 
788 
807 -(RETURN_CODE) emv_removeTerminalData;
808 
828 -(RETURN_CODE) emv_retrieveAIDList:(NSArray**)response;
829 
830 
859 -(RETURN_CODE) emv_retrieveApplicationData:(NSString*)AID response:(NSDictionary**)responseAID;
860 
883 -(RETURN_CODE) emv_retrieveCAPK:(NSString*)rid index:(NSString*)index response:(CAKey**)response;
884 
885 
917 -(RETURN_CODE) emv_retrieveCAPKFile:(NSString*)rid index:(NSString*)index response:(NSData**)response;
918 
938 -(RETURN_CODE) emv_retrieveCAPKList:(NSArray**)response;
939 
940 
941 
961 -(RETURN_CODE) emv_retrieveCRLList:(NSMutableArray**)response;
962 
963 
964 
965 
966 
988 -(RETURN_CODE) emv_retrieveTerminalData:(NSDictionary**)responseData;
989 
1011 -(RETURN_CODE) emv_retrieveTransactionResult:(NSData*)tags retrievedTags:(NSDictionary**)retrievedTags;
1012 
1059 -(RETURN_CODE) emv_setApplicationData:(NSString*)aidName configData:(NSDictionary*)data;
1060 
1080 -(RETURN_CODE) emv_setCAPK:(CAKey)key;
1081 
1099 -(RETURN_CODE) emv_setCAPKFile:(NSData*)file;
1100 
1124 -(RETURN_CODE) emv_setCRLEntries:(NSData*)data;
1125 
1126 
1127 
1128 
1174 -(RETURN_CODE) emv_setTerminalData:(NSDictionary*)data;
1175 
1176 
1177 
1178 
1179 
1206 -(RETURN_CODE) emv_startTransaction:(double)amount amtOther:(double)amtOther type:(int)type timeout:(int)timeout tags:(NSData*)tags forceOnline:(BOOL)forceOnline fallback:(BOOL)fallback;
1207 
1208 
1219 -(RETURN_CODE) config_getSerialNumber:(NSString**)response;
1220 
1235 -(RETURN_CODE) icc_exchangeAPDU:(NSData*)dataAPDU response:(APDUResponse**)response;
1266 -(RETURN_CODE) icc_getICCReaderStatus:(ICCReaderStatus**)readerStatus;
1267 
1283 -(RETURN_CODE) icc_powerOnICC:(NSData**)response;
1284 
1285 
1286 
1301 -(RETURN_CODE) icc_powerOffICC:(NSString**)error;
1302 
1313 -(RETURN_CODE) msr_cancelMSRSwipe;
1314 
1327 -(RETURN_CODE) msr_startMSRSwipe;
1328 
1332 -(bool) isConnected;
1333 
1334 @end
RETURN_CODE device_startRKI()
void deviceDisconnected()
Fires when device disconnects.
NSString * SDK_version()
NSString * device_getBLEFriendlyName()
Definition: IDTMSRData.h:21
Definition: IDT_BTPayMini.h:14
id< IDT_BTPayMini_Delegate > delegate
Definition: IDT_BTPayMini.h:68
Definition: APDUResponse.h:14
bool device_disableBLEDeviceSearch()
RETURN_CODE msr_cancelMSRSwipe()
RETURN_CODE msr_startMSRSwipe()
Definition: IDTCommon.h:13
Definition: IDTCommon.h:42
NSUUID * device_connectedBLEDevice()
RETURN_CODE emv_removeTerminalData()
RETURN_CODE ctls_startTransaction()
RETURN_CODE ctls_cancelTransaction()
Definition: IDT_BTPayMini.h:67
void deviceConnected()
Fires when device connects. If a connection is established before the delegate is established (no del...
RETURN_CODE ctls_removeAllCAPK()
RETURN_CODE emv_removeCRLList()
IDT_BTPayMini * sharedController()
Definition: IDTEMVData.h:16