Grillparzerstraße 18 81675 Munich Germany P +49 (89) 45 230 - 291 F +49 (89) 45 230 – 099 [email protected] PAY.ON Platform Documentation PayPipe Integration Release 1.5.5 PayPipe Documentation – XML Integrator 1 Grillparzerstraße 18 81675 Munich Germany P +49 (89) 45 230 - 291 F +49 (89) 45 230 – 099 [email protected] Release History Release Description Date Changes 0.9.0 Alpha Version 0.9.1 Beta Version 0.9.2 Minor Release 0.9.3 Minor Release 2009-01-27 Return codes, brands, changes in request and response messages 0.9.4 Minor Release 2009-02-05 Recurring Payment, Connection to PayPipe, Certification process 0.9.5 Minor Release 2009-04-04 Recurring Payment changes, XML samples changes 1.0.0 Major Release 2009-05-01 Changes to Certification Process 1.0.1 Minor Release 2009-05-23 Changes to Customer Required Field Definiitions 1.0.2 Minor Release 2009-06-22 Extensions to AVS Support 1.0.3 Minor Release 2009-07-13 Added new certification tests for swiss francs (CHF) 1.1.0 Major Release 2009-08-01 New Return Codes 1.1.1 Minor Release 2009-09-30 New TransactionCategories: MAIL_ORDER and TELEPHONE_ORDER as required by several acquirers 1.1.2 Minor Release 2009-10-20 New Brand MILESANDMORE 1.1.3 Minor Release 2009-10-29 Better description of common used terms 1.1.4 Minor Release 2009-11-08 More information on payment types 1.2.0 Major Release 2009-11-12 Added new certification tests for currencies, recurring and 3DSecure 1.2.1 Minor Release 2010-01-25 Added PayPipe HTTP Access error codes Appendix A.4 1.2.2 Minor Release 2010-04-21 Changes to tag <amount> in group “ReferencedTransaction” 1.3.0 Major Release 2010-05-10 Added workflow description, updates on certification for asynchronous workflows 1.3.1 Minor Release 2010-06-08 Added XML request and response samples for certification (Appendix C) New XML request and response tags added 1.3.2 Minor Release 2010-07-28 Minor changes for clarifications 1.4.0 Major Release 2012-02-21 Include SHA-1 SecurityHash as digital signature 1.5.0 Major Release 2012-03-28 Adding MarketData to enable Airline-processing 1.5.1 Minor Release 2012-04-18 Minor changes for clarifications 1.5.2 Minor Release 2012-07-06 Minor changes for clarifications 1.5.3 Minor Release 2012-07-27 Added return codes 1.5.4 Minor Release 2012-09-19 Brands updated – previousAmount added 1.5.5 Minor Release 2013-07-15 Clarification about account details in reference Transactions PayPipe Documentation – XML Integrator 2 Grillparzerstraße 18 81675 Munich Germany P +49 (89) 45 230 - 291 F +49 (89) 45 230 – 099 [email protected] PayPipe Documentation – XML Integrator 3 Grillparzerstraße 18 81675 Munich Germany P +49 (89) 45 230 - 291 F +49 (89) 45 230 – 099 [email protected] Preface PAY.ON Platform Documentation - PayPipe Integration Copyright © 2012 PAY.ON AG. All rights reserved. Printed in Germany / European Union The information contained in this document is intended only for the person or entity to which it is addressed and contains confidential and/or privileged material. Any review, retransmission, dissemination or other use of, or taking of any action in reliance upon, this information by persons or entities other than the intended recipient is prohibited. If you received this in error, please contact PAY.ON AG and delete the material from any computer. Contact Information For questions relating to this document please contact: PAY.ON AG Grillparzerstraße 18 81675 Munich Germany phone: +49 89 45230 291 e-mail: [email protected] PayPipe Documentation – XML Integrator 4 Grillparzerstraße 18 81675 Munich Germany P +49 (89) 45 230 - 291 F +49 (89) 45 230 – 099 [email protected] Content 1 Introduction ..................................................................................................................... 7 1.1 Target Audience ........................................................................................................ 7 1.2 Conventions .............................................................................................................. 7 2 Technical Information ....................................................................................................... 9 2.1 PayPipe Routing Mechanism ...................................................................................... 9 2.2 Character Set and Encoding ....................................................................................... 9 2.3 Security .................................................................................................................... 9 3 PayPipe XML Sample Request and Responses................................................................ 10 3.1 PayPipe XML Request Sample ................................................................................. 10 3.2 PayPipe XML Response Sample ................................................................................. 11 3.3 PayPipe XML Asynchronous Response Sample ......................................................... 12 4 Workflows ..................................................................................................................... 14 5 Payment Types ............................................................................................................. 17 5.1 Preauthorization (PA) ............................................................................................... 18 5.2 Preauthorization Supplement (PA) ............................................................................ 19 5.3 Capture (CP) ........................................................................................................... 20 5.4 Debit (DB) ............................................................................................................... 21 5.5 Credit (CD) ............................................................................................................. 22 5.6 Refund (RF) ............................................................................................................ 23 5.7 Reversal (RV) ......................................................................................................... 24 6 Details for implementation .............................................................................................. 25 6.1 Mode ...................................................................................................................... 25 6.2 Identification Tag Group ........................................................................................... 25 6.3 Merchant Accounts .................................................................................................. 26 6.4 Country Codes ........................................................................................................ 26 6.5 Payment ................................................................................................................. 26 6.6 Account Tag Groups ................................................................................................ 27 6.6.1 CreditCardAccount .......................................................................................... 27 6.6.2 BankAccount .................................................................................................. 27 6.6.3 VirtualAccount ................................................................................................ 27 6.7 Authentication ......................................................................................................... 28 6.8 AVS (Address Verification Servie) ............................................................................. 28 6.9 CVV Validation ........................................................................................................ 29 6.10 ConnectorTxIds ................................................................................................... 30 6.11 Recurring Transactions ........................................................................................ 30 6.12 Merchant Category .............................................................................................. 30 6.13 Airline Data ......................................................................................................... 31 7 XML Tag Glossary ......................................................................................................... 33 7.1 Request and Response Tag ..................................................................................... 33 7.2 Transaction Tags for XML Request ........................................................................... 33 PayPipe Documentation – XML Integrator 5 7.3 Transaction Tags for XML Response ......................................................................... 39 7.4 Response Validation – HASH Digital Signature .......................................................... 42 8 Integration Process ........................................................................................................ 43 8.1 Apply for test and live accounts ................................................................................. 43 8.2 Connectivity and Security ......................................................................................... 43 8.3 Error Simulation ....................................................................................................... 44 8.4 Certification ............................................................................................................. 44 8.4.1 General Information ........................................................................................