CLIQ Platform Documentation Implementation Packages

Transcription

1 CLIQ Platform Documentation Implementation Packages Release CLIQ Platform Documentation Implementation Packages 1

2 Release History Release Description Date Changes Initial Version 30 Jan Minor Release 05 Mar 2004 Added Perl XML implementation Minor Release 04 Apr Added PHP WPF implementation Minor Release 10 Jun 2004 Added PHP XML implementation Minor Release 22 Jun 2004 Update Java implementation Minor Release 17 Aug 2004 Update PHP XML implementation Minor Release 09 Sep Update PHP POST and WPF implementation Minor Release 28 Sep 2004 Added CFM WPF implementation Minor Release 05 Apr Added ASP and JSP implementation Minor Version 20 Feb Reviewed and cleaned up Major Version 23 Jul 2010 Reviewed Minor Version 24 Oct 2012 New LWP and SSLeay links Major Version 18 July 2014 Reviewed and cleaned up CLIQ Platform Documentation Implementation Packages 2

3 Preface PSP Platform Documentation - Implementation Packages Copyright 2014 CLIQ Payments - 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 CLIQ Payments and delete the material from any computer. CLIQ Platform Documentation Implementation Packages 3

4 Content Release History... 2 Preface Introduction Java Implementation Package Installation How-to integrate with XML Perl Integration Package Installation How-to integrate with XML PHP Integration Package Installation How-to integrate with XML Hosted payment pages COPYandPAY JSP Implementation Package Installation How-to integrate with XML XMLIntegration.jsp MyReceiver.java Other Packages / Languages CLIQ Platform Documentation Implementation Packages 4

5 1 Introduction We aim to set a positive benchmark regarding the time needed to integrate. Please help us to achieve this goal by contacting your account manager with any feedback regarding our integration process, packages, or other concerns. Currently the following integration packages are provided and can be downloaded respectively from our website: Java Perl PHP ASP (deprecated, not documented) Cold Fusion (deprecated, not documented) JSP Each integration package contains the necessary utilities and helper classes to make integration as simple as possible. Some integration packages even include sample shop applications as well as unpack-and-run installers. NOTE: The packages available and described are sample implementations. The implementations are ready-to-use within their own environment, however the sample implementations may not be the best path for a given use case. NOTE 2: The following packages are primarily recommended for merchant integration. For gateway-to-gateway integrations please refer to the XML Integration and XML Query documentation. CLIQ Platform Documentation Implementation Packages 5

6 2 Java Implementation Package 2.1 Installation The Java sample packages can be downloaded from the following URL: Should HTTPS (SSL) certificates be needed, please accept the certificate via you browser. The following classes can be used for integration after untarring the package: de.payment.integration.processing.requestsender a service class responsible for sending an XML request de.payment.integration.model.ccbean a model bean that holds all the necessary properties for a standard XML credit card request de.payment.integration.model.ddbean a model bean that holds all the necessary properties for a standard XML direct debit request The provided project contains a test class that shows how to use the services provided by the upper classes. This package is developed and tested with jdk on Windows XP and SuSe Linux 9.0. Use ant 1.6 or higher to build the package. Simply move to the directory integration/working. The following ant targets can be used: - ant wipe: wipes out all compiled classes - ant build: builds the payment.integration.jar from scratch - ant TestSender: test the RequestSender by sending a request to the test system as described in the Technical_Quick_Start documentation chapter 3 System Access. Should one of the interafaces need to be used, place the following jar file payment.integration.jar which is located in the target/dist directory into your classpath and use the classes in the same manner as the de.payment.integration.test.testrequestsender class does. All the additional jar files needed at runtime can be found in the target/libs directory,. The test cases use a default test merchant called: CLIQ Platform Documentation Implementation Packages 6

7 DEMOMERCHANT For security reasons, the sender ID for this test merchant is changing from time to time. Please connect to to obtain the up-to-date test merchant information. Fill the received information into the file integration/src/config.properties to get the TestRequestSender working. It is also possible to use configuration data from an existing merchant rather than the test merchant. 2.2 How-to integrate with XML Find a sample implementation of the following steps in working/de/payment/integration/test/testrequestsender.java Put the jar file payment.integration.jar (located in the target/dist directory) into your classpath. 1) In the first step create a de.payment.integration.model.ccbean (or DDBean) instance and fill it with all the information relevant for the payment method you are willing to integrate. 2) Then create a CCBean pb new CCBean(); pb.setversion("1.0"); pb.setsender( REPLACE_WITH_ID ); pb.setresponse("sync"); pb.setchannel( REPLACE_WITH_ID ); pb.setmode("integrator_test"); pb.setpwd( payment );... de.payment.integrator.processing.requestsender instance. The constructor expects the URL to connect to: String url = " RequestSender sender=new RequestSender(url); CLIQ Platform Documentation Implementation Packages 7

8 3) Send the request and get the response as an XML Stringback String xmlresponse = sender.send(pb); 4) Finally, parse the XML response string to determine the success or failure of the transaction. CLIQ Platform Documentation Implementation Packages 8

9 3 Perl Integration Package 3.1 Installation The Perl package can be downloaded from the following URL: Save the file to a working directory and untar it. Afterwards, navigate to the directory pip. The following files are present: main.pl test code for connecting once via XML and once via P3. pip.pm this module contains the code for sending the xml and http data to the gateway. In this file you have to edit you DemoMerchantInfo link. Replace it with the link presented in the Technical Quickstart Documentation. request.pm a perl module containing a string constant that is being used for interpolation of the xml data. readme.txt In order to have this example running you need to install the following programs/perl modules. LWP: This is the basic perl library for internet protocols. it can be found at SSLeay: this library enables the LWP library to connect via HTTPS/SSL. You can download it at OpenSSL: A SSL lib that is used by SSLeay. You can find it at For windows user using the active state distribution a pm is available for the builds 618 & 522. Please see o Please ensure that the OpenSSL version used is the most current! The file main.pl contains some test code that connects to our gateway and sends two requests, one via the xml interface the other via the P3 interface. After successfully connecting, debug responses are printed to the console. The test code uses the default test merchant called: DEMOMERCHANT For security reasons the sender ID for this test merchant changes from time to time. Please connect to CLIQ Platform Documentation Implementation Packages 9

10 to obtain the up-to-date test merchant information, or use a pre-configured test merchant account provided by your account manager How-to integrate with XML If using a custom environment with the sample code is preferred is preferred, first move the files to path and include it than via the following statement: use pip; Follow up by sending a request by calling the sendxmlrequest function and pass the necessary parameters. The function returns an XML String that has to be parsed afterwards to get the result details of the payment transaction. $response = sendxmlrequest( url => " transaction_channel => " ", transaction_mode => "INTEGRATOR_TEST", transaction_response => "SYNC", account_year => "2005", account_authorisation => "", account_verfifcation => "530", account_brand => "VISA", account_number => " ", account_month => "07", account_holder => "bob kosel",... name_give => "Robert", name_family => "Kosel"); // get payment transaction status if ($response =~ /.*\<Result\>ACK\<\/Result\>.*/) { print "Request ACK\n"; } CLIQ Platform Documentation Implementation Packages 10

11 4 PHP Integration Package 4.1 Installation The PHP sample package can be downloaded from the following URL: Save and untar the file to a working directory. The following files will be extracted: wpf-example.php test code for WPF (deprecated in favour of COPYandPAY) wpf-integrator.php this module contains the code for sending the payment parameters to the gateway. This class is needed for WPF integration. (deprecated in favour of COPYandPAY) xml-example.php test code for connecting via XML. xml-integrator.php this class contains the functions and code for sending an XML-request to the gateway. This example is tested with Apache Web Server ( and PHP4.3 with CURL support enabled and built with SSL support (libcurl , OpenSSL 0.9.7b zlib 1.1.4) please ensure your OpenSSL libraries are the most current! The test code uses the default test merchant called: DEMOMERCHANT For security reasons the sender ID, channel, user and password for this test merchant change from time to time. Please connect to to obtain the up-to-date test merchant information, or use your own test merchant credentials. CLIQ Platform Documentation Implementation Packages 11

12 4.2 How-to integrate with XML Files needed: xml-example.php, xml-integrator.php If a self-built environment is preferable, first move the files provided to your path and include them via the following statement: include( xml-integrator.php ); Requests can then be sent by calling the functions as described and shown in xml-example.php. There are several functions available for committing payments: _ctpexmlpost($server,$path,$sender,$channel,$userid,$userpwd,$transaction_mode,$transact ion_response) setaccountinformation($account_holder,$account_brand,$account_number,$account_bankna me,$account_country,$account_authorisation,$account_verification,$account_year,$account_ month) setpaymentinformation($payment_code,$payment_amount,$payment_usage,$payment_curre ncy) setcustomercontact($contact_ ,$contact_mobile,$contact_ip,$contact_phone) setcustomeraddress($address_street,$address_zip,$address_city,$address_state,$address_co untry) setcustomername($name_salutation,$name_title,$name_give,$name_family,$name_company ) commitxmlpayment() The parameters of these functions are described in xml-example.php and xml-integrator.php. CLIQ Platform Documentation Implementation Packages 12

13 4.3 Hosted payment pages COPYandPAY As with any of the integration options, hosted payment pages can be integrated by using the following guide: CLIQ Platform Documentation Implementation Packages 13

14 5 JSP Implementation Package 5.1 Installation The JSP sample package can be downloaded from the following URL: Save and untar the file to a working directory of a web application server such as Tomcat. If you need the https certificates, either pull the certificate via your browser or download a ready to use keystore from (keystore password passctpe ) In the web application integration you will find the following files: Jsp files: JSP files to be directly called for XML and WPF integrations src foldercontains the source for a servlet needed for WPF integration configure folder files to get the samples running. This example is tested on Linux and Windows on Tomcat The test code uses the default test merchant called: DEMOMERCHANT For security reasons the sender ID, channel, user and password for this test merchant change from time to time. Please connect to to obtain the up-to-date test merchant information, or use a pre-configured test merchant account provided by your account manager How-to integrate with XML The URL is the default URL for accessing the integration package, assuming a stock install of Tomcat. If any errors are thrown, please check the configure folder in the webapp. CLIQ Platform Documentation Implementation Packages 14

15 5.2.1 XMLIntegration.jsp The example is kept very simple and does not use any marshalling framework to create the XML or to process the response. It provides a quick start for XML integrations please refer to the XML integration documents for further information MyReceiver.java This servlet is called after payment has finished and returns the URL for end-user redirection. CLIQ Platform Documentation Implementation Packages 15

16 6 Other Packages / Languages For other languages, please use the COPYandPAY integration guide or post XML or POST requests via HTTPS. Other merchant integration paths are available (known as WPF), however as of this document they are deprecated in favour of XML, POST and COPYandPAY integrations. CLIQ Platform Documentation Implementation Packages 16