Magtek DynaPro Programmer's Manual
  1. Manuals
  2. Brands
  3. Magtek Manuals
  4. Payment Terminal
  5. DYNAPRO
  6. Programmer's manual

Magtek DynaPro Programmer's Manual

Sdk - magneflex powder, middleware
Hide thumbs Also See for DynaPro:
Table of Contents

Advertisement

Quick Links

Download this manual
SDK - MagneFlex Powder,
MIddleware,
PIN PEDs
Programmer's Manual (MagneFlex API)
February 2021
Manual Part Number:
D998200118-70
REGISTERED TO ISO 9001:2015
MagTek I 1710 Apollo Court I Seal Beach, CA 90740 I Phone: (562) 546-6400 I Technical Support: (888) 624-8350
www.magtek.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the DynaPro and is the answer not in the manual?

Questions and answers

Related Manuals for Magtek DynaPro

Summary of Contents for Magtek DynaPro

  • Page 1 SDK - MagneFlex Powder, MIddleware, PIN PEDs Programmer’s Manual (MagneFlex API) February 2021 Manual Part Number: D998200118-70 REGISTERED TO ISO 9001:2015 MagTek I 1710 Apollo Court I Seal Beach, CA 90740 I Phone: (562) 546-6400 I Technical Support: (888) 624-8350 www.magtek.com...
  • Page 2 No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of MagTek, Inc. MagTek® is a registered trademark of MagTek, Inc.

  • Page 3: Software License Agreement

    ATTENTION: CUSTOMER SUPPORT. TERMS, CONDITIONS, AND RESTRICTIONS MagTek, Incorporated (the "Licensor") owns and has the right to distribute the described software and documentation, collectively referred to as the "Software." LICENSE: Licensor grants you (the "Licensee") the right to use the Software in conjunction with MagTek products.
  • Page 4 Agreement and will not affect the enforceability of any of the remaining provisions. This Agreement shall be governed by the laws of the State of California and shall inure to the benefit of MagTek, Incorporated, its successors or assigns.

  • Page 5: Table Of Contents

    How to Set Up the MagneFlex Powder .................. 10 How to Connect MagneFlex Powder Service to a Host ..........10 How to Connect DynaPro Mini to a Windows Host via BLE ........10 MagneFlex Powder Resources ....................14 CheckHealth ........................14 RequestCardSwipe ......................
  • Page 6 0 - Table of Contents Appendix A TLV Data Format ....................37 ARQC Message Format ....................37 ARQC Response (from online processing) ..............37 Transaction Result Message – Batch Data Format ............. 38 SDK - MagneFlex Powder, MIddleware,| PIN PEDs | Programmer’s Manual (MagneFlex API) Page 6...

  • Page 7: Introduction

    IPAD, DynaPro, and DynaPro Mini connected to a Windows-based host via USB, BLE, or by Ethernet. It is part of a larger library of documents designed to assist IPAD, DynaPro, and DynaPro Mini implementers, which includes the following documents available from MagTek: ...

  • Page 8: Sdk Contents

    MagTek PPSCRA interface library MTPPSCRANET.DLL MagTek PPSCRA library for .Net MTPPSCRA.WEBAPI.DLL MagTek PPSCRA library for WEB API MTPPServiceNet.DLL MagTek PPSCRA connection service library for .Net MTEMVTLVParser.DLL MagTek PPSCRA TLV EMV Parser MTTLV.DLL MagTek PPSCRA TLV library Sample SOAPUI project: File Description MTPPSCRA WEB API Sample-soapui-project.xml...

  • Page 9: System Requirements

    DynaPro Windows 7, Windows 8, 8.1 & Windows 10 ETHERNET Windows 7, Windows 8, 8.1 & Windows 10 DynaPro Mini Windows 7, Windows 8, 8.1 & Windows 10 Windows 8, 8.1 & Windows 10 DynaPro Go Windows 7, Windows 8, 8.1 & Windows 10 Windows 8, 8.1 &...

  • Page 10: How To Set Up The Magneflex Powder

    How to Connect DynaPro Mini to a Windows Host via BLE To connect DynaPro Mini to a host with Windows 8.1 or higher and Bluetooth 4.0 hardware that supports BLE, follow these steps: 1) If you are using an external Bluetooth adapter, install any required drivers and connect it to the host.
  • Page 11 2 - How to Set Up the MagneFlex Powder b) Touch the Bluetooth icon in the system tray and select (see Figure Add a Bluetooth Device 2-1). Figure 2-1 - Launch Manage Bluetooth Devices App from Desktop Mode Figure 2-2 – Windows 8 Manage Bluetooth Devices App 9) Locate the serial number on the label on the bottom of the device.
  • Page 12 2 - How to Set Up the MagneFlex Powder (or the device’s actual password if it has been configured differently), 12) Enter default passcode 000000 then press the button. Windows will return you to the page. Next Manage Bluetooth devices After a short period of time, you will see the text below the device you are pairing with.
  • Page 13 2 - How to Set Up the MagneFlex Powder 15) Remember to change the default password. See the DynaPro Mini Programmer’s Reference documents for details. To unpair from the device: 1) Locate the device in the Manage Bluetooth devices window.

  • Page 14: Magneflex Powder Resources

    3 - MagneFlex Powder Resources MagneFlex Powder Resources MagneFlex Powder can be hosted as a Windows service (MagTek PPSCRA WEBAPI Host service or executable (MTPPSCRA.WEBAPI.Host.exe). CheckHealth Returns the operational status of the MagnFlex Powder. Using Method GET: api/mtppscrahost/CheckHealth Return Value: A string array containing API name and status.

  • Page 15: Requestemvtags

    3 - MagneFlex Powder Resources WaitTime Time in seconds the device will wait for the action to be completed. (1 - 255) DisplayMessage Message to prompt the user with: 0 = Swipe Card / Idle alternating 1 = Swipe Card 2 = Please Swipe Card 3 = Please Swipe Card Again 4 = Chip Error, Use Mag Stripe...
  • Page 16 3 - MagneFlex Powder Resources Parameter Description DeviceID URI of the device. For USB devices, Use an empty string to open the first device found. Otherwise use: USB://DEVICESERIALNUMBER Example, USB://99261829170E0810 For Ethernet devices, use the form: IP://IPAddress:PORT Example, IP://10.57.10.180:26 For 802.11 Wireless devices, use in the form: TLS12://TLSDEVICESERIALNUMBER TLS12TRUST://TLSDEVICESERIALNUMBER Example, TLS12://TLS99261829170E0810...

  • Page 17: Requestmanualswipe

    3 - MagneFlex Powder Resources Data TLV data block to send to the device. Data block must be formed as an F9 CBC-MAC container message. Reference the device manual for details. AAAA /* 2-byte MSB message length excluding padding and CBC-MAC */ F9<len>...
  • Page 18 3 - MagneFlex Powder Resources Parameter Description DeviceID URI of the device. For USB devices, Use an empty string to open the first device found. Otherwise use: USB://DEVICESERIALNUMBER Example, USB://99261829170E0810 For Ethernet devices, use the form: IP://IPAddress:PORT Example, IP://10.57.10.180:26 For 802.11 Wireless devices, use in the form: TLS12://TLSDEVICESERIALNUMBER TLS12TRUST://TLSDEVICESERIALNUMBER Example, TLS12://TLS99261829170E0810...

  • Page 19: Requestpin

    3 - MagneFlex Powder Resources Parameter Description CloseDevice Flag which determines whether the connection to the device will be closed after the request is processed. Default value is “false”. “false” = Do no close the device. “true” = Close device. EndSession Flag which determines whether an EndSession command is sent to the device after the request is processed.
  • Page 20 3 - MagneFlex Powder Resources Parameter Description DeviceID URI of the device. For USB devices, Use an empty string to open the first device found. Otherwise use: USB://DEVICESERIALNUMBER Example, USB://99261829170E0810 For Ethernet devices, use the form: IP://IPAddress:PORT Example, IP://10.57.10.180:26 For 802.11 Wireless devices, use in the form: TLS12://TLSDEVICESERIALNUMBER TLS12TRUST://TLSDEVICESERIALNUMBER Example, TLS12://TLS99261829170E0810...

  • Page 21: Requestsignature

    3 - MagneFlex Powder Resources Parameter Description CloseDevice Flag which determines whether the connection to the device will be closed after the request is processed. Default value is “false”. “false” = Do no close the device. “true” = Close device. EndSession Flag which determines whether an EndSession command is sent to the device after the request is processed.
  • Page 22 3 - MagneFlex Powder Resources Parameter Description DeviceID URI of the device. For USB devices, Use an empty string to open the first device found. Otherwise use: USB://DEVICESERIALNUMBER Example, USB://99261829170E0810 For Ethernet devices, use the form: IP://IPAddress:PORT Example, IP://10.57.10.180:26 For 802.11 Wireless devices, use in the form: TLS12://TLSDEVICESERIALNUMBER TLS12TRUST://TLSDEVICESERIALNUMBER Example, TLS12://TLS99261829170E0810...

  • Page 23: Requestsmartcard

    3 - MagneFlex Powder Resources “SignatureData”:} , “AdditionalOutputData”:{}} RequestSmartCard Begins an EMV transaction. Using Method POST: api/mtppscrahost/RequestSmartCard( string DeviceID, int CardType, int ConfirmationWaitTime, int PINEntryWaitTime, int Tones, int Options, int TransactionType, decimal Amount, decimal CashBack, int Reserved, array AdditionalRequestData, boolean CloseDevice, boolean EndSession);...
  • Page 24 2 = Contact smart card 3 = Magnetic stripe or contact smart card 4 = Contactless smart card (Not supported on DynaPro Mini) 5 = Contactless smart card + magnetic stripe 6 = Contactless smart card + contact smart card 7 = Magnetic stripe + contact smart card + contactless smart card.

  • Page 25: Requestsendacquirerresponse

    3 - MagneFlex Powder Resources Parameter Description EndSession Flag which determines whether an EndSession command is sent to the device after the request is processed. Default value is “false”. When set to false, this flag may facilitate the display of a custom message after a request is processed.
  • Page 26 3 - MagneFlex Powder Resources Parameter Description DeviceID URI of the device. For USB devices, Use an empty string to open the first device found. Otherwise use: USB://DEVICESERIALNUMBER Example, USB://99261829170E0810 For Ethernet devices, use the form: IP://IPAddress:PORT Example, IP://10.57.10.180:26 For 802.11 Wireless devices, use in the form: TLS12://TLSDEVICESERIALNUMBER TLS12TRUST://TLSDEVICESERIALNUMBER Example, TLS12://TLS99261829170E0810...

  • Page 27: Releasedevice

    3 - MagneFlex Powder Resources CloseDevice Flag which determines whether the connection to the device will be closed after the request is processed. Default value is “false”. “false” = Do no close the device. “true” = Close device. EndSession Flag which determines whether an EndSession command is sent to the device after the request is processed.
  • Page 28 3 - MagneFlex Powder Resources Parameter Description DeviceID URI of the device. For USB devices, Use an empty string to open the first device found. Otherwise use: USB://DEVICESERIALNUMBER Example, USB://99261829170E0810 For Ethernet devices, use the form: IP://IPAddress:PORT Example, IP://10.57.10.180:26 For 802.11 Wireless devices, use in the form: TLS12://TLSDEVICESERIALNUMBER TLS12TRUST://TLSDEVICESERIALNUMBER Example, TLS12://TLS99261829170E0810...

  • Page 29: Requestoperationstatus

    3 - MagneFlex Powder Resources EndSession Flag which determines whether an EndSession command is sent to the device after the request is processed. Default value is “false”. When set to false, this flag may facilitate the display of a custom message after a request is processed.

  • Page 30: Magneflex Powder Response Output Structures

    MagneFlex Powder Response Output Structures The MagneFlex Powder returns the following outputs. CheckHealth Output Returned after CheckHealth. A string array containing API name and status. Example: "MagTek PPSCRA WEB API", "OK" CardSwipe Output Returned after a card swipe. Example : "CardSwipeOutput":...

  • Page 31: Manualswipe Output

    4 - MagneFlex Powder Response Output Structures "Track2Length": 39, "Track2Status": 0, "Track3Length": 106, "Track3Status": 0, "StatusCode": 0, "CardData": "CardType=1|OperationStatus=0|CardStatus=0|DataType=34|Track1Status=0| Track1Length=78|Track1=%B4019000000000003000^FIREMAN/TEST D ^1610000000000000000000000000?|Track2Status=0|Track2Length=39|Track2=; 4019000000000003000=16100000000000000?|Track3Status=0|Track3Length=106 |Track3=;4019000000000003000=00000000000000000000000000000000000000000 0000000000000000000000000000000000000000000?|EncTrack1Status=0|EncTrac k1Length=80|EncTrack1=C5389DFDB735F9D9EF628E0FDC446FB9CCBEBE959DECD226 55737B41CD249D6C672446BF77A3738D09FBF8DD55A61906CB50C697994344DDFE657C 3F8ED287BD4141788C400BAEFBA0E52BE1498AE186|EncTrack2Status=0|EncTrack2 Length=40|EncTrack2=12BA7B8F7386EB4ED1EAD4467E621E26930A269FA733607B73 AEE894F8F9B5A3367066B822881FE5|EncTrack3Status=0|EncTrack3Length=112|E ncTrack3=12BA7B8F7386EB4ED1EAD4467E621E26F727B4225A3C8F73351BEF09B1ED7 4971CE9A1B4F84A1440109735A65864FAA2384D29912454DE6B37485C4060D8809AD7A 00C24F2D78A340CEBDD00CE0AF419BAC7C9F89DD4415D45B578B962EE4126D6EB943AB C5D729B45E7C09060B3E3AB|EncMPStatus=0|EncMPLength=56|EncMP=787E070A18E CF5087595FD4CDE53E550051E719BDCBCF29C7646D6B5AF90EEEEA88713ADE97F11809 5C8CF3C36426FAD860E1BF5C3465D21|MPSTS=00002200|MSStatus=0|KSN=95000300 00000120073D|SerialNumber=98D90C660E070F0E|PAN=12BA7B8F7386EB4ED1EAD44 67E621E26930A269FA733607B32040311C324348B|CBCMAC=7202CDF1", "CBCMAC": "7202CDF1", "KSN": "9500030000000120073D", "MagnePrintStatus": "00002200", "PANData":...
  • Page 32 4 - MagneFlex Powder Response Output Structures "DataType": 34, "EncryptedMagnePrint": "", "EncryptedTrack1": "D5FCF8CAA7EB399A13D097C58D6D39123EA41CDCB45E3C3C4FAF1741984114DC5BD60 6E2AD201321C00E08A359B42D7CB4EA09B8853D11161E505BB7EF621CDD", "EncryptedTrack2": "819EAA4AF1962A3BD08AEC151002BB03C42D731AAD37CC76DDD8BCDE0F93963BA9CED 1B157D630D4", "EncryptedTrack3": "", "EncryptedMagnePrintLength": 0, "EncryptedMagnePrintStatus": 1, "EncryptedTrack1Length": 64, "EncryptedTrack1Status": 0, "EncryptedTrack2Length": 40, "EncryptedTrack2Status": 0, "EncryptedTrack3Length": 0, "EncryptedTrack3Status": 1, "MagStripeStatus": 0, "PANDataLength": 32, "Track1Length": 57, "Track1Status": 0, "Track2Length": 39, "Track2Status": 0,...

  • Page 33: Pin Output

    4 - MagneFlex Powder Response Output Structures "AdditionalOutputData": null PIN Output Returned after a PIN request. The PINData key contains a comma delimited value: Field Value Name PIN KSN PIN Key serial number Encrypted PIN block opStatus Operation status Example: "PINOutput": {"PINData":"9A006300000001200065,59D0274E9F58DD5F,0"}, "AdditionalOutputData": null Signature Output...

  • Page 34: Transaction Output Smartcard

    4 - MagneFlex Powder Response Output Structures "AdditionalOutputData": null Transaction Output SmartCard Returned after a SmartCard request. Example: {"TransactionOutput": { "TransactionType": 0, "TransactionStatus": 255, "OperationStatus": 0, "DataType": 1, "ARQCData": "01A4F98201A0DFDF540A9500030000000120071BDFDF550182DFDF250898D90C660E0 70F0EFA82017D70820179DFDF5301005F201A564953412041435155495245522054455 3542F434152442030325F30020201DFDF4D273B3434323730303030303930303030303 33333373D32323132303030303030303030303030303FDFDF520105F882011EDFDF598 20100B00A0A84B0C31AF16B79E3309DC808B34DC05F71F094C78FC8A81F074EA3E5033 2ED61FC3921D319AA76E45CD26466A4F46E3B3C7D1D0280A0C395D66DF4010D1D0A59A E65A7276AD0E764BFB34A44A514B32664710A8176F8771737B6B3D0F82F65B6F2375F7 5C575513F658F9749A01903F37E3E7DD09F1B048A8077A9017677879F4146DD15F211F 2967624CD8C41C1662F0F9BF4D842370125AA44114E286F8CD51D31C8E6F4774A74096 EECB06437DC07EFA01F5846DF751D13F5547A0E016A9AB51B84146365D9B501D608F7C 44A5880AC5FBBBC2ECF6EFD1BA141644FC27578C677AF5FBF21D6E3C65C77233CA7F7C 7A250C2E289597F9FFD224854F0DFDF560A9500030000000120071BDFDF570180DFDF5 801060000F3E97338", "BatchData": null,...

  • Page 35: Transaction Output Arpc

    4 - MagneFlex Powder Response Output Structures 880AC5FBBBC2ECF6EFD1BA141644FC27578C677AF5FBF21D6E3C65C77233CA7F7C7A25 0C2E289597F9FFD224854F0", "MerchantData": null, "FallbackIndicator": "00", "MaskedICCTrack2": "3B343432373030303030393030303030333333373D323231323030303030303030303 03030303F", "ServiceCode": "0201", "CardHolderName": "5649534120414351554952455220544553542F43415244203032", "CardType": "05", "ApprovalStatus": -1 Transaction Output ARPC Returned after sending an ARPC. Example: {"TransactionOutput": { "TransactionType": 1, "TransactionStatus": 0, "OperationStatus": 0, "BatchData": "01E7F98201E3DFDF540A9500030000000120071BDFDF550182DFDF250898D90C660E0 70F0EFA8201C0F08201BCF105DFDF1A0100F8820106DFDF598200E8CD1C5D6F158B03D...

  • Page 36: Data Output

    Returned after sending a SendCommand. The Data output contains the respsonse report sent from the device. SET returns the ACK status. GET returns the report data in response to the requested command. Example of a SET to DynaPro: 01 – is an ACK response report.
  • Page 37 Appendix A – TLV Data Format Appendix A TLV Data Format ARQC Message Format This section gives the format of the ARQC Message delivered in the ARQC Message notification. It is a TLV object with the following contents: F9<len>/* container for MAC structure and generic data */ DFDF54(MAC KSN)<len><val>...
  • Page 38 Appendix A – TLV Data Format Transaction Result Message – Batch Data Format This section gives the format of the data the device uses to do completion processing FE<len> /* container for generic data */ DFDF25(IFD Serial Number)<len><val> FA<len>/* container for generic data */ F0<len>...

This manual is also suitable for:

Dynapro goDynapro miniIpad

Table of Contents