background image

ID TECH ViVOpay VP3320 User Manual 

 

Page | 11  

5.

 

ID TECH Universal SDK 

By virtue of its EMV L2 kernel, VP3320S is designed to be compatible with a wide range of third-
party payment applications. ID TECH offers a Universal SDK (available for iOS, Android, or 
Windows) to enable rapid application development using VP3320S as the target device. The 
languages supported include Objective C (on iOS), Java (on Android), and C# (on Windows). The 
Universal SDK includes rich, powerful libraries that make sending commands to the VP3320S 
comparatively easy while greatly facilitating debugging and event handling. 
 
To obtain the Universal SDK free of charge, visit ID TECH's 

VP3320S product page

 and select the 

version of the SDK that applies to your desired host platform (Android, iOS, Linux, MacOS, or 
Windows). 
 
Normally, development of applications that take advantage of VP3320S's capabilities can be done 
in a high-level language like C# or Java (using convenience objects and data structures defined in 
the Universal SDK), obviating the need to send byte commands directly. Nevertheless, it is 
possible to communicate with the device at a low level if necessary. For a command reference for 
VP3320S, request the 

NEO Interface Developers Guide 

(IDG), P/N 80139403-001. This document 

includes not only low level (firmware) commands but error codes, response codes, and 
information on various default settings. 
 

5.1.

 

Updating VP3320S Firmware 

ID TECH strongly recommends updating firmware via the Universal SDK. Consult the Universal 
SDK Guide for your desired platform (included in the ZIP file downloaded from th

VP3320S 

product page

) for integration details. 

 

Note:

 Firmware downloads must be done via a USB-C to USB-A cable or a USB OTG cable for 

mobile Android devices.

 

 

 

Содержание ViVOpay VP3320S

Страница 1: ...ID TECH 10721 Walker Street Cypress CA 90630 4720 Tel 714 761 6368 Fax 714 761 8880 www idtechproducts com ViVOpay VP3320S Integration Manual 80173501 001 Rev E 21 September 2020 ...

Страница 2: ...ment Except as permitted by such license no part of this publication may be reproduced or transmitted by electronic mechanical recording or otherwise or translated into any language form without the express written consent of ID TECH ID TECH and ViVOpay are trademarks or registered trademarks of ID TECH Warranty Disclaimer The services and hardware are provided as is and as available and the use o...

Страница 3: ...d in accordance with the instructions may cause harmful interference to radio communications However there is no guarantee that interference will not occur in a particular installation If this equipment does cause harmful interference to radio or television reception which can be determined by turning the equipment off and on the user is encouraged to try to correct the interference by one or more...

Страница 4: ...ply with all relevant local ordinances or regulations Do not dispose of the battery pack in municipal waste Dispose used batteries according to the instructions The battery pack contains a small amount of harmful substances To avoid injury Keep the battery pack away from open flames or other heat sources Do not expose the batter pack to water rain or other corrosive liquids Do not leave the batter...

Страница 5: ...2 6 1 Using the Demo Application 12 7 VP3320S LOW LEVEL COMMANDS 13 7 1 Activate Transaction Command 02 40 13 7 2 Set CA Public Key D0 03 14 7 3 Get Processor Type 09 02 15 7 4 Get Main Firmware Version 09 03 16 7 5 Get Hardware Information 09 14 16 7 6 Get Module Version Information 09 20 18 7 7 Get Serial Number 12 01 19 7 8 Contact Set ICS Identification 60 16 20 7 9 Contact Set Terminal Data 6...

Страница 6: ...opers is available for developing applications that communicate with VP3320S Contact your acquirer gateway or POS partner for instructions on setting up and pairing the VP3320S to a compatible payment application and associated host device 2 Major VP3320S Features Communicates via Bluetooth BLE Bluetooth Low Energy Supports Apple iOS and Android platforms Rechargeable battery no external power nec...

Страница 7: ...IRWIN Discover DPAS American Express ExpressPay Interac Flash MIFARE Apple Pay and Apple VAS Samsung Pay NFC Android Pay Google Pay Softcard Smart Tap 2 1 JCB Contactless FeliCa 2 2 Other Agency Approvals and Compliances CE EN55022 EN55024 Class B FCC Part 15 Class B RoHS DIRECTIVE 2011 65 EU UL REACH EMV Contact L1 L2 EMV Contactless L1 TQM PCI PTS 5 X SRED MIC Telec ...

Страница 8: ... more information on using an iPad or iPhone in conjunction with the VP3320S 1 Enable the Bluetooth device search function on the host device smart phone or tablet 2 Make sure the VP3320S is charged or connected to a power source via USB o When connected to a power source the VP3320S automatically activates Bluetooth 3 When not connected to a power source press the VP3320S s power button for two s...

Страница 9: ...uding power management Bluetooth transactions and security Device State LED1 LED2 LED3 LED4 Sound Battery charging on off off off None Battery power low2 on off off off None Bluetooth ready blink off off off None Bluetooth connected successfully blink off blink off None Bluetooth in sleep mode off off off off None Bluetooth on standby blink off off off None Transaction successful on on on on Unit ...

Страница 10: ...after a device is selected by its friendly name see the next paragraph the Apple iOS calculates a unique identifier to allow any that device to make further connections directly The VP3320S has a default friendly name of IDTECH_BLE This is the default name the ID TECH Universal SDK uses to connect to the first VP3320S it encounters if no other friendly name is set in the SDK or when the iOS genera...

Страница 11: ...ux MacOS or Windows Normally development of applications that take advantage of VP3320S s capabilities can be done in a high level language like C or Java using convenience objects and data structures defined in the Universal SDK obviating the need to send byte commands directly Nevertheless it is possible to communicate with the device at a low level if necessary For a command reference for VP332...

Страница 12: ... host device with a USB to micro USB cable not included 2 Double click the UniversalSDKDemo exe file and allow a few seconds for the main window to appear see illustration below The Universal SDK Demo app displays VP3320S s available commands in a command tree as shown above Single click on a command to populate the center panel of the window with optional settings relevant to the command for exam...

Страница 13: ...1 Define the type of interface to be activated with 02 40 Interface selection Bit 0 MSR Bit 1 Contactless Bit 2 Contact DF EF 37 01 07 07 0000 0111 This activates transaction for all 3 interfaces DF EF 3C 03 Fallback support and Timeout value for waiting for the next command mainly to support EMV workflow Byte 1 Fallback support 0x00 not support fallback 0x01 support fallback Byte 2 3 Timeout for ...

Страница 14: ...many command details particularly TLV information See the NEO 2 Interface Developer s Guide available from your ID TECH representative for the full Activate Transaction 02 40 description 7 2 Set CA Public Key D0 03 The Set CA Public Key command adds a new key to the reader Command Frame Byte 0 9 Byte 10 Byte 11 Byte 12 Byte 13 Byte 14 18 Byte 19 Bytes 19 n Byte n 1 Byte n 2 Header Tag Protocol Ver...

Страница 15: ...essor Type 09 02 The Get Processor Type command returns a processor type TLV Command Frame Response Frame The Get Processor Type sub command returns a TLV string as follows Tag 0xDF61 Length 0x02 Value a field representing the processor type The following types of processors may be identified in the Value field Processor Type hex values Description 45 00 ARM7 LPC21xx 4D 00 ARM Cortex M4 K21 Family...

Страница 16: ...4 65 63 68 32 00 09 03 00 00 C0 CE Response 56 69 56 4F 74 65 63 68 32 00 09 00 00 14 DF 62 11 43 72 61 6E 65 56 65 6E 64 69 5F 31 2E 30 2E 30 00 E1 5D 7 5 Get Hardware Information 09 14 The Get Hardware Information command retrieves information about the reader s hardware Command Frame Byte 0 9 Byte 10 Byte 11 Byte 12 Byte 13 Byte 14 Byte 15 Header Tag Protocol Command Sub Command Data Length MSB...

Страница 17: ...F 74 65 63 68 32 00 09 00 00 15 48 57 2C 56 50 56 65 6E 64 69 0D 0A 4B 32 31 46 20 52 65 76 39 ASCII Description HW VP3300 Audio Jack CR LF K21F Rev9 Unipay III HW VPUnipay1 5 CR LF K21F Rev9 Unipay 1 5 HW VPUniPay1 5TTK CR LF K21F Rev9 UniPay 1 5 TTK HW VP3300 USB CR LF K21F Rev9 VP3300 USB VP3300 USB OEM iBase Cake same code HW VP3300 USB E CR LF K21F Rev9 VP3300 USB E HW VP3300 USB C CR LF K21F...

Страница 18: ...0 53 45 20 4D 6F 64 75 6C 65 2C 20 76 31 2E 30 30 2C 2C 0D 0A 20 43 4C 20 41 49 44 2C 4D 61 73 74 65 72 43 61 72 64 20 50 61 79 50 61 73 73 20 4D 2F 43 68 69 70 20 76 33 2E 30 2E 32 2C 20 56 65 6E 64 69 20 76 31 2E 30 2E 30 2C 2C 0D 0A 20 43 4C 20 41 49 44 2C 56 69 73 61 20 56 43 50 53 20 32 2E 31 2E 33 2C 20 76 30 2E 39 39 2C 2C 0D 0A 20 43 4C 20 41 49 44 2C 41 6D 65 78 20 45 78 70 72 65 73 73 50...

Страница 19: ...mand fails with a Command Not Allowed error status If the command frame is not valid the reader returns an error response frame Command Frame Byte 0 9 Byte 10 Byte 11 Byte 12 Byte 13 Byte 14 Byte 15 Header Tag Protocol Version Command Sub Command Data Length MSB Data Length LSB CRC LSB CRC MSB ViVOtech2 0 12h 01h 00h 0Fh The serial number will be returned tail padded with 0x00 to a length of 15 Ex...

Страница 20: ...73635343332319f4e2231303732312057616c6b65 722053742e20437970726573732c204341202c5553412edf260101df1008656e6672 65737a68df110101df270100dfee150101dfee160100dfee170107dfee180180dfee 1e08f0dc24f0c20e1400dfee1f0180dfee1b083030303135313030dfee20013cdfee 21010adfee2203323c3caa88 Reader responds with 5669564f746563683200600000003d35 Success Command Frame Byte 0 9 Byte 10 Byte 11 Byte 12 Byte 13 Byte 14 B...

Страница 21: ...15 n Header Tag Protocol Version Command Sub Command Data Length MSB Data Length LSB Data CRC LSB CRC MSB ViVOtech2 0 60h 06h Data Objects Data Objects TagCounterL TagCounterH TLV1 TLV2 TLVn Where TagCounterL TagCounterH the Number of TLV tags Response Frame Byte 0 9 Byte 10 Byte 11 Byte 12 Byte 13 Byte 14 Byte 14 n 1 Byte 14 n Byte 15 n Header Tag Protocol Version Command Status Code Data Length ...

Страница 22: ...t transaction log 1 00 14 DF27 support exception file 1 00 15 DFEE15 Terminal support ASI 1 01 16 DFEE16 Terminal encrypt mode 1 00 17 DFEE17 Terminal entry mode for ICC 1 07 18 DFEE18 Terminal encrypt mode for MSR 1 80 19 DFEE1E Contact terminal configuration 8 D0 DC 20 D0 C4 1E 16 00 20 DFEE1F Issuer script limit 1 80 21 DFEE1B ARC define 8 30 30 30 31 35 31 30 30 22 DFEE20 ICC power on detect w...

Страница 23: ... x x x RFU x x x x 0 x x x RFU x x x x x 0 x x RFU x x x x x x 0 x RFU x x x x x x x 0 RFU Byte 2 b8 b7 b6 b5 b4 b3 b2 b1 Meaning Change 1 x x x x x x x Plaintext PIN for IC verification Major x 1 x x x x X x Enciphered PIN for online verification Major x x 1 x x x X x Signature paper Major x x x 1 x x X x Enciphered PIN for offline verification Major x x x x 1 x X x No CVM Required Major x x x x ...

Страница 24: ...Byte 2 b8 b7 b6 b5 b4 b3 b2 b1 Meaning Change 1 x x x x x x x Cash Deposit x 0 x x x x x x RFU x x 0 x x x x x RFU x x x 0 x x x x RFU x x x x 0 x x x RFU x x x x x 0 x x RFU x x x x x x 0 x RFU x x x x x x x 0 RFU Byte 3 b8 b7 b6 b5 b4 b3 b2 b1 Meaning Change 1 x x x x x x x Numeric keys x 1 x x x x x x Alphabetic and special characters keys x x 1 x x x x x Command keys x x x 1 x x x x Function K...

Страница 25: ...pport Default Disable Major 0 Disable 1 Enable 1 DFEE1E Contact Terminal Configuration Default F0 DC 3C F0 C2 9E 94 00 Byte 1 b8 b7 b6 b5 b4 b3 b2 b1 Meaning Change 1 x x x x x x x Key Pad support x 1 x x x x x x LCD support x x 1 x x x x x PIN Pad support x x x 1 x x x x Print Support x x x x 0 x x x RFU x x x x x 0 x x RFU x x x x x x 0 x RFU x x x x x x X 0 RFU Byte 2 b8 b7 b6 b5 b4 b3 b2 b1 Me...

Страница 26: ...nal action code support Major x 1 x x x x x x Terminal action code can be change Major x x 1 x x x x x Terminal action code can be deleted or disable Major x x x 1 x x x x Default Action code processing before 1st GAC Major x x x x 1 x x x Default Action code processing after 1st GAC Major x x x x x 1 x x TAC IAC default process when unable to go online Skipped Major x x x x x x 1 x TAC IAC defaul...

Страница 27: ...x 0 RFU Byte 8 b8 b7 b6 b5 b4 b3 b2 b1 Meaning Change x x x x x x x x RFU 7 10 Contact Set Application Data 60 03 The Contact Set Application Data command creates a new AID configuration up to a maximum of 16 sets Command Frame Byte 0 9 Byte 10 Byte 11 Byte 12 Byte 13 Byte 14 Byte 14 n 1 Byte 14 n Byte 15 n Header Tag Protocol Version Command Sub Command Data Length MSB Data Length LSB Data CRC LS...

Страница 28: ...ta ID Tag Value name Length Byte Data 1 9F01 Acquirer identifier 6 56 49 53 41 30 30 2 5F57 Account type 1 00 3 5F2A Transaction Currency 2 08 40 4 9F09 Terminal application version number 2 00 96 5 5F36 Transaction currency exponent 1 02 6 9F1B Terminal floor limit 4 00 00 3A 98 7 DF25 Default DDOL Var 9F 37 04 8 DF28 Default TDOL Var 9F 08 02 9 DFEE15 ASI 1 01 10 DF13 TAC Default 5 00 00 00 00 0...

Страница 29: ...form the following steps and commands to read a card with the VP3320S via USDK methods 1 Set the device s terminal settings a Run Set Kernel Configuration public RETURN_CODE emv_setTerminalMajorConfiguration int configuration b Run Set Terminal Configuration public RETURN_CODE emv_setTerminalData byte tlv string ident 2 Run Set Application Data public RETURN_CODE emv_setApplicationData byte name b...

Страница 30: ...nit was not activated Contact IDTECH Support 4 Yellow LEDs are on LCL KEK is not loaded or was erased Contact IDTECH Support 4 Green LEDs are on DEK is not loaded or was erased Contact IDTECH Support No communication and all LEDs off Power off Battery out of charge Host device not connected Charge the battery Press the device Reset button Make sure to enter the correct paring password Bluetooth pa...

Страница 31: ... to exit Passthrough mode Need to cancel transaction Fail to start transaction 0x60 returned No terminal data or application data Need to load terminal data or application data for Contact EMV transactions Fail to start transaction 0x04 returned Missing Key Please re start VP3320S and monitor the LEDs to confirm whether to Load LCL key or Data Key Firmware loading software indicates Open device fa...

Отзывы: