Implementation guide Web Services V4. Version 1.4b

Transcription

1 Implementation guide Web Services V4 Version 1.4b

2 Confidentiality All the information in the current document is considered confidential. Using it outside the context of this consultation or disclosing it to exterior persons is subject to prior approval by Lyra Network.

3 SUMMARY 1. Purpose Notions of timeout Error Handling Data Types definitions Maintain HTTP session API Use Cases and Examples D-Secure transaction process Create a transaction with 3D-Secure authentication (card enrolled) Verify the cardholder s enrolment status Redirect the cardholder to ACS Handle ACS Response Handle the authentication result and complete the transaction Create a transaction without 3D-Secure authentication Create a payment with 3D-Secure handled by merchant s MPI plugin Update a transaction Cancel a transaction Refund a transaction Duplicate a transaction Retrieve a transaction Validate a transaction Methods createwiththreeds() finalyzewiththreeds create() modify() cancel() refund() duplicate() getinfo() validate() force() Objects createpaymentinfo createpaymentgeneralinfo createcardinfo createsubpaymentinfo createcustomerinfo createshippinginfo createextrainfo paymentcreationinfo threedsresult custstatus deliveryspeed deliverytype extinfo createwiththreedsresponse verespareqinfo transactioninfo transactionpaymentgeneralinfo transactioncardinfo transactionthreedsinfo... 58

4 transactionauthorizationinfo transactionmarkinfo transactionwarrantydetailsinfo localcontrol transactioncaptureinfo transactioncustomerinfo transactionshippinginfo transactionextrainfo standardresponse Appendices Test credit card numbers Transaction statuses Bank response code (used for authresult and markresult) Net PHP Sample code : signature computation (create method)... 73

5 1. Purpose This document presents the standard Web services which allow you to create transactions (with or without 3D-Secure authentication) and to act on the transactions. Web services have been developed in accordance with the following SOAP protocol (Simple Object Access Protocol). The web service description language document for the service is available at In order to make exchanges secure, Web services (SOAP) are encrypted thanks to the HTTPS protocol. Moreover, a signature mechanism has been set up to validate and authenticate data Network- 1/79

6 2. Notions of timeout A Web service request s processing is made of a series of asynchronous operations such as: sending of the request via the merchant site s network, transferring data across the Internet, payment s processing by the payment gateway, requesting the acquirer and the issuer, etc A connection failure may occur in every step and increase the process s runtime. A response can take a long time for several reasons: High response time from issuer bank s server, (foreign credit cards, period of high server load,...) high response time from acquirer bank s server when sending the authorization, high response time from merchant side during peaks in traffic, High response time from payment gateway. Internet Peering issues, etc... Depending how you have configured timeouts in your application, you can give up and close the connection, while the payment gateway is still processing your request. Be careful, a long response time must not be considered as a payment declined. You should configure your code to handle potential problems with connecting to the SOAP API. Best practices The average response time to handle a payment request is less than 5s. So, you should set client-side timeout to 20 to 30s. When a Web Service request exceeds the timeout limit time, you should not inform the shopper that the payment has been declined. If you do so, the shopper will try to make another payment while the first try is still in progress by the gateway. It would be better to choose one of the following solutions: 1. Inform the shopper that the payment is in progress. Asynchronously, ask the gateway for the status of the transaction. Then you can notify the shopper with the result of his purchase. 2. Inform the shopper that the payment has been declined Make sure you won t validate the transaction (suppose the payment to be created with manual Network- 2/ 79

7 3. Error Handling You can review the codes below to help troubleshoot your development efforts and fix any problems you might have. ErrorCode in a TransactionInfo Object: Error Error Error Message Error Message Code Code 0 Action successfully completed 62 Invalid input field orderinfo2 1 Unauthorized request 63 Invalid input field orderinfo3 2 TransactionID was not found 64 Invalid input field paymentsource 3 Bad transaction status 65 Invalid input field cardnetwork 4 Transaction already exists 66 Invalid input field contractnumber 5 Incorrect signature computation 67 Invalid input field customerid 6 TransmissionDate is too far from current UTC date 68 Invalid input field customertitle 10 Invalid input field amount 69 Invalid input field customername 11 Invalid input field currency 70 Invalid input field customerphone 12 Unknown card type 71 Invalid input field customermail 13 Invalid input field expirydate 72 Invalid input field customeraddress 14 Invalid input field cvv 73 Invalid input field customerzipcode 15 Unknown contract number 74 Invalid input field customercity 16 Invalid input field cardnumber 75 Invalid input field customercountry 17 CardIdent not found 76 Invalid input field customerlanguage 18 Invalid cardident (cancelled, ) 77 Invalid input field customerip 19 SubscriptionID was not found 78 Invalid input field customersendmail 20 Invalid Subscription 79 Invalid input field customermobilephone 21 CardIdent already exists 80 Invalid input field subpaiementtype 22 cardident creation declined 81 Invalid input field subreference 23 cardident purged 82 Invalid input field initialamount 26 Nothing has changed 83 Invalid input field occinitialamount 27 Amount not authorized 84 Invalid input field effectdate 40 Card range not found 85 Invalid input field state 50 Invalid input field siteid invalide 86 Invalid input field customeraddressnumber 51 Invalid input field transmissiondate 87 Invalid input field customerdistrict 52 Invalid input field transactionid 88 Invalid input field customerstate 53 Invalid input field ctxmode 90 Invalid input field enrolled 54 Invalid input field comment 91 Invalid input field authstatus 55 Invalid input field AutoNb 92 Invalid input field eci 56 Invalid input field AutoDate 93 Invalid input field xid 57 Invalid input field capturedate 94 Invalid input field cavv 58 Invalid input field newtransactionid 95 Invalid input field cavvalgo 59 Invalid input field validationmode 96 Invalid input field brand 60 Invalid input field orderid 98 Invalid input field requestid 61 Invalid input field orderinfo1 99 Unknown Network- 3/ 79

8 ErrorCode in a verespareqinfo object: Error Error Description Description Code Code 0 Action successfully completed 8 Invalid ACS Signature 1 Unauthorized request 9 Technical error 2 Incorrect signature computation 10 Wrong Parameter 3 Brand not found 11 Incorrect date format 4 Invalid card number 12 3DS Disabled 5 No suitable contract 13 cardident not found 6 Ambiguous contract 14 PAN not found 7 Merchant not enrolled 99 Unknown error PaymentError in a transactioninfo object Error Error Error Message Error Message Code Code 1 Transaction not found. 72 #N/A 2 Transaction not found. 73 Pre-authorization declined. 3 This action is not authorized on a transaction with the status {0}. 74 Invalid payment configuration. 4 This transaction is not authorized in this context. 75 The operation was declined by Paypal. 5 This transaction already exists. 76 A technical problem occurred. We are not able to process your request. 6 Invalid transaction amount. 77 Following a technical problem, we are not able to process your request. 7 This operation is no longer allowed for a transaction created on this date. 78 #N/A 8 The card expiry date does not allow this operation. 79 #N/A 9 CVV is compulsory for this card. 80 #N/A 10 The credit amount is higher than the initial amount. 81 The content of the configuration theme is not valid. 11 The credit amount is higher than the initial amount. 82 Refund is not authorized for this contract. 12 The duplication of a refund is not authorized. 83 Transaction amount outside the allowed values. 13 A technical problem occurred. We are not A technical problem occurred. We are not able to 84 able to process your request. process your request. 14 A technical problem occurred. We are not A technical problem occurred. We are not able to 85 able to process your request. process your request. 15 A technical problem occurred. We are not A technical problem occurred. We are not able to 86 able to process your request. process your request. 16 A technical problem occurred. We are not A technical problem occurred. We are not able to 87 able to process your request. process your request. 17 The remote setting of the Aurore contract A technical problem occurred. We are not able to 88 failed. process your request. 18 The analysis of the Cetelem response failed. 89 This modification is not authorized. 19 Unknown currency. 90 An error occurred during the refund of this transaction. 20 Invalid type of card. 91 No payment option enabled for this contract. 21 No contract found for this payment. Please change the data or contact your manager 92 #N/A in case of multiple failures. 22 POS not found. 93 #N/A 23 Ambiguous contract. 94 #N/A 24 Invalid contract. 95 A technical problem occurred. We are not able to process your request. 25 A technical problem occurred. We are not An error occurred during the capture of this 96 able to process your request. Network- 4/ 79

9 25 A technical problem occurred. We are not able to process your request. 97 #N/A 26 Invalid card number. 98 Invalid transaction date. 27 Invalid card number. 99 #N/A 28 Invalid card number. 100 #N/A 29 Invalid card number. 101 Declined because the first installment has been declined. 30 Invalid card number. (Luhn) 102 The operation was declined by Buyster. 31 Invalid card number. (length) 103 The transaction status failed to be synchronized with the external system 32 Invalid card number. (not found) 104 An error occurred during the capture of this transaction. 33 Invalid card number. (not found) 105 A security error occurred when processing 3DS information for this transaction. 34 Card with unconditional authorization control failed. 106 Unsupported currency on this contract and/or shop. 35 E-carte bleue control failed. 107 #N/A 36 The risk control has caused a declined A technical problem occurred. We are not able to 108 transaction. process your request. 37 #N/A 109 #N/A 38 A technical problem occurred. We are not able to process your request. 110 Payment card not supported by the contract D Secure was declined for this transaction. 111 Refusal of transactions without liability shift. 40 A technical problem occurred. We are not able to process your request. 112 The cancellation is not authorized 41 A technical problem occurred. We are not able to process your request. 113 Duplication is not permitted 42 #N/A 114 Forcing is not authorized 43 #N/A 115 Refund is not authorized 44 It is not possible to force an imprint 116 MOTO payment is not authorized for this card 45 Invalid currency for this change. 118 Multiple installments are not authorized for this card 46 The amount exceeds the maximum authorized amount. 119 The date submitted is not valid 47 The presentation date that was requested is The option of payment of the initial transaction is not 120 later than the authorization's validity date. applicable 48 The required change is not valid. 121 #N/A 49 Invalid definition of multiple installment. 122 #N/A 50 Unknown POS. 123 #N/A 51 Unknown exchange rate. 124 #N/A 52 This contract was closed on {0}. 125 #N/A 53 The shop {0} is closed since {1}. 126 #N/A 54 This parameter that was rejected may include sensitive data {0}. 128 #N/A 55 A technical problem occurred. We are not able to process your request. 129 #N/A 57 Problem with the buyer account recovery. 130 #N/A 58 This buyer account is not compatible with this operation 131 #N/A 59 Problem with the buyer account recovery. 132 A technical problem occurred. We are not able to process your request. 60 This buyer account already exists. 133 #N/A 61 Invalid buyer ID. 134 #N/A 62 Creation of the buyer account declined. 135 The integration of the payment page into an iframe is not authorized. 63 This recurring payment already exists. 136 Refusal of the derived transactions, without liability shift on the primary transaction. 64 This recurring payment is already terminated. 137 #N/A 65 Invalid recurring payment. 138 #N/A 66 The rule of recurring payment is not valid. 139 #N/A 67 Creation of the recurring payment declined. 140 Network- 5/ 79

10 69 A technical problem occurred. We are not able to process your request. 70 Invalid country code Invalid web service parameter. 141 The risk analyzer rejected this transaction. The used type of card is not valid for the requested payment Network- 6/ 79

11 Specification about TransactionInfo error codes 0 Action successfully completed This means that the request has been processed with success and therefore that the request's format is correct. Note: In case of a payment creation (create and createwiththreeds() method) this error code must not be mistaken with the transactionstatus field which returns the payment result. It is indeed possible to get a 0 errorcode and an 8 transactionstatus. This case matches with a transaction creation which authorization request has been declined. 1 Unauthorized request You do not have access to web services. Please contact Systempay support. 15 Unknown contract number Something is wrong with the merchant's contract. Several cases are possible: The value contained in the request does not match with any contract associated with the shop (siteid), There is no contract associated with the shop, The contract is closed, The type of contract is not allowed to process the payment. Occurs when your merchant account doesn t support CNP (card-not-present) transactions and the value of the field paymentsource is either MOTO, CC or OTHER in your payment request. 27 Amount not authorized The amount you want to debit or refund, doesn t match with your merchant account specifications (such as minimal and maximum amount allowed per transaction). Please contact Systempay support for more informations. Specification about verespareqinfo error codes 9 technical error This error code can be returned in several cases. Most frequently, the contract number (createcardinfo.contractnumber) provided in your request is invalid. Please contact Systempay support to obtain more Network- 7/ 79

12 4. Data Types definitions Data Types are used to form a message type and either be populated by merchant (request) or by PayZen (Response). Data Representation Notations indicates how data is represented. Data Representation Notations Description a Alphabetic characters A--Z and a--z n Numeric digit 0-9 s Special character Alphabetic and numeric characters (excluding space and an special characters) ans Alphabetic, numeric, space and special characters Data Length Notations indicates the format of the data length. Data length Notations Description digit Fixed length in number of positions digit(s) Variable length, with maximum number of positions specified. Data types Description A Boolean data type can only have one of two values: true or false. boolean These values can also be represented as true, yes, or 1 (one), or false, no, or 0 (zero). A datetime data type represents a specific moment in time as both a date and a time. It contains a year, a month, and a date, and also hours, seconds, and milliseconds. datetime The value is in the Coordinated Universal Time (UTC). Unlike local time, any given date and time in UTC is the same everywhere on earth simultaneously. Int Long String An int (integer) data type is a whole number without a decimal point or any value that would follow a decimal point. For example, 1 is an integer. However, 1.0 and 1. are not integers. The long data type is a 64-bit signed two's complement integer. This data type is used when the int data type is not large enough (to specify transaction amount for example). The string data type can contain characters, line feeds, carriage returns, and tab Network- 8/ 79

13 5. Maintain HTTP session Important: As the payment platform architecture works with load balanced servers, on a short time interval it is necessary that every request concerning the same payment are processed on the same HTTP session in order to keep the process' continuity. To do so, for each request a session is created by the server. The session ID is sent back in the HTTP header of the response. It has to be sent back within the following requests in order that they can be processed by the same server. JAVA code sample Use the SESSION_MAINTAIN_PROPERTY property and make sure to set it to true in order to maintain the session. Service service = Service.create(wsdlURL, qname); ThreeDSecure port = service.getport(threedsecure.class); ((BindingProvider) port).getrequestcontext().put(bindingprovider.session_maintain_property, true); PHP code sample First of all, you need to get the SESSION ID sent back in the response of the first call. Use the getlastresponseheader method and save the cookie named JSESSIONID. Then use the setcookie method to add the JSESSIONID cookie in the header of each call of a series of API calls. /* Get all the response headers */ $header = $client-> getlastresponseheaders(); /* Find the «JSESSIOND» field : */ if(!preg_match("#jsessionid=([a-za-z0-9\._]+)#",$header, $matches)){ return "NO SESSIONID SENT BY THE SERVER." ; //technical error } $cookie = $matches[1]; /*Add a new cookie in the header of the next request */ $client-> setcookie ("JSESSIONID", $cookie); We recommend you to store the JSESSIONID in your data base. You will have to send it in your request to finalize the payment after a 3D-Secure authentication. The payer authentication may take a few Network- 9/ 79

14 6. A certificate is mandatory to communicate with the payment gateway. It is available for every person who have the right to view your shop's certificates. They appear in PayZen's Merchant Back Office in Setting / Shops, Certifcates tab. There are two distinct certificates: one for the test platform and the other for the production platform. The signature is computed as follows: Creation of a string composed of the parameters separated with the "+" symbol. Addition of the "certificate" (test or production depending on the context) to this string. Hash of the final string with the SHA1algorithm. The payment gateway always checks the signature. It is on the merchant's responsibility to check the signature returned by the payment gateway. The order of the fields must be respected. The numerical fields must not have any 0 on the first digit's left. The boolean fields can only take these two values: - 1 for true - 0 for false The string fields that are not valued must be left empties. To simplify the computation, object of class datetime are not taken in account. On TEST mode, if the signature's computation is not correct, the error code returns 5. The string used to compute the signature on the server's side is then returned in the extendederrorcode Network- 10/ 79

15 7. API Use Cases and Examples D-Secure transaction process Step 1 - Shopper browses at merchant site and finalizes purchase. Step 2 - The merchant invokes a web service (createwiththreeds request) to the PayZen gateway with the necessary data to process the payment. Step 3 - PayZen sends query including card number to VISA or MASTERCARD Directory Servers. Step 4 - If card number is not participating, PayZen process the authorization request and returns a transactioninfo object to merchant and processing ends. If card number is in a participating card range, Systempay returns a verespareqinfo object containing: - the Access Control Server (ACS) URL - the Payer Authentication Request message (PAReq) - the 3DS request ID (threedsrequestid) Step 5 - The merchant stores in the field MD (merchant data), the session ID (JSESSIONID) transmitted in the HTTP response header, and the 3DS request ID (threedsrequestid). Step 6 - The merchant initiates a form post (ACS Request) that posts the values retrieved from verespareqinfo to the ACS via the shopper s browser, including the field MD. It is at this stage that the card holder will be prompted for their 3D-Secure PIN code. Step 7 - ACS authenticates shopper as appropriate for the card number then formats the ACS Result message. Step 8 - ACS returns the ACS result (PARes) and the merchant data (MD) to merchant via shopper s browser. Step 9 - The merchant invokes a web service (finalizewiththreeds) to the PayZen gateway with the 3DS request ID (transmitted in the field MD) and the ACS Result (PARes). Step 10 - PayZen validates Payer Authentication Response signature. If successful, PayZen proceeds with authorization exchange with acquirer. Step 11 - PayZen returns a transactioninfo object to merchant and processing Network- 11/ 79

16 7.2. Create a transaction with 3D-Secure authentication (card enrolled) Verify the cardholder s enrolment status 1. Create a new createpaymentinfo objet. 2. Populate at least all of the required fields for the paymentgeneralinfo object. 3. Populate at least all of the required fields for the cardinfo object. 4. Populate at least all of the required fields for the extrainfo object. 5. If you need, you can use some optional fields. Refer to the createwiththreeds method description s section. 6. Proceed with the signature computation (see below). 7. Call the createwiththreeds() method, passing in the createpaymentinfo object created in the previous steps and the wssignature field. 8. Systempay returns a createwiththreedsreponse object. Check for the value of the errorcode field. o If the errorcode value is 0, o o o o Get the verespareqinfo object from the response. Get the JSESSIONID cookie from the HTTP headers of the response. Proceed with the browser redirection to the ACS (refer to next section) If the errorcode value is not 0, then process the errors. wssignature = SHA1(siteId+transactionId+paymentSource+orderId+orderInfo+orderInfo2+orderInfo3 +amount+currency+validationmode+cardnumber+cardnetwork+expirymonth +expiryyear+cvv+cardident+cardbirthday+contractnumber+paymentoptioncode +subpaymentinfo+custormerinfo+shippinginfo +ctxmode+browesruseragent+browseraccept+certificate) wssignature = SHA1( EC+cmde-test VISA Network- 12/ 79

17 SOAP Request example <ns1:createwiththreeds> <createinfo> <paymentgeneralinfo> <siteid> </siteid> <transmissiondate> t10:40:58+00:00</transmissiondate> <transactionid>420582</transactionid> <paymentsource>ec</paymentsource> <orderid>cmde-test</orderid> <amount>12590</amount> <currency>978</currency> <presentationdate> t10:40:58+00:00</presentationdate> <validationmode>1</validationmode> </paymentgeneralinfo> <cardinfo> <cardnumber> </cardnumber> <cardnetwork>visa</cardnetwork> <expirymonth>12</expirymonth> <expiryyear>2021</expiryyear> <cvv>111</cvv> </cardinfo> <extrainfo> <ctxmode>test</ctxmode> </extrainfo> </createinfo> <wssignature>8696c57d909498c2a0d1b7dbc2daea98c85f346b</wssignature> </ns1:createwiththreeds> Response header [Response Header] HTTP/ OK Date: Tue, 11 Mar :40:58 GMT Server: Apache Set-Cookie: JSESSIONID=2B42D2D1A7A0F A7534D2844A.bdxvad2;Path=/vads-ws;Secure; HttpOnly Access-Control-Allow-Origin: * Vary: Accept-Encoding,User-Agent Connection: close Transfer-Encoding: chunked Content-Type: text/xml;charset=utf-8 SOAP Response example <ns1:createwiththreedsresponse xmlns:ns1=' <return> <errorcode>0</errorcode> <timestamp> </timestamp> <signature>5e9bc4c4145d59297f7f6a c1067</signature> <verespareqinfo> <errorcode>0</errorcode> <signature>5755b5cdd881527ed355b917fb6b37db9335ff1f</signature> <timestamp> </timestamp> <threedsacctid>aee5962cddb048aab650bac6f7d1</threedsacctid> <threedsacsurl> <threedsbrand>visa</threedsbrand> <threedsencodedpareq> ejxvutty4jam/zvm3s4oribdr2szaok+il1s83cgaibyhjxj7gpkkkowv4wl/pfkyxpc+s0aymli5fky0e= </threedsencodedpareq> <threedsenrolled>y</threedsenrolled> <threedsrequestid>_c13b0d69-ad0e-4fa1-926f-23cc90b723c0</threedsrequestid> </verespareqinfo> </return> Network- 13/ 79

18 Redirect the cardholder to ACS Once the verespareqinfo received, you have to redirect the browser to the ACS by means of a form POST submitted automatically. This form POST is sent to the ACS s url received in the createwiththreeds response (threedsacsurl). <form method= POST action= threedsacsurl value > </form> It must contain the fields below: Name PaReq String TermUrl String MD Data Type Description String Payer Authentication Request. This is the threedsencodedpareq variable in the createwiththreeds response. (see verespareqinfo object) The TermUrl is the url that the card holder will get redirected to once the ACS has completed authentication. (see next section) Merchant DATA. In this field, you can send some data needed after the authentication to identify the customer and resume the process. We recommend to populate it with a combination of the JSESSIONID and the threedsrequestid, separated by a + character : JSESSIONID+requestId Mandatory Field Example: Note for test mode ONLY In test mode, you have to send the JSESSIONID when redirecting the browser to the ACS s test URL in order to maintain HTTP session. To do so, you have to add the JSESSIONID to the ACS s URL, separated by a semi column character as shown below: ${URL};jsessionid=${session} <form name="form" method="post" action=" >... </form> When working in LIVE MODE, you MUST NOT SEND the JSESSIONID to the Network- 14/ 79

19 Example <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " <html xmlns=" xml:lang="fr" lang="fr"> <head> <meta http-equiv="content-type" content="text/html;charset=utf-8"/> <title>---</title> <script type="text/javascript"> <!-- function submitform(){ document.redirectform.submit(); } --> </script> </head> <body onload="settimeout(\'submitform()'.'\',500);"> <span class="message">redirection ACS</span> <br/> <br/> <br/> <form name="redirectform" action="acsurl" method="post"> <input type="hidden" name="pareq" value=" threedsacsurl "/> <input type="hidden" name="termurl" value="url_de_retour"/> <input type="hidden" name="md" value="threedsrequestid " /> <noscript><input type="submit" name="go" value="click to continue"/></noscript> </form> </body> Network- 15/ 79

20 Handle ACS Response Once submitting the Payer authentication request, the ACS server will authenticating the request and redirect to page passed as TermUrl in the above section. On the redirected page, you will find: PaRes : PARes message (Payer Authentication Response) MD : Merchant Data sent in the request You have to extract from the field MD the values of Jsession ID and threedsrequestid. Pass these values to call finalizewiththreeds method (see next section). Example of TermUrl page: In the following example, the field MD consists of the Jsession ID and the request ID, separated by the character +. <?php session_start();?> <html> <head></head> <body> <?php $PaRes = $_POST['PaRes']; List($JSESSIONID, $requestid) = explode («+», $_POST['MD']) ; //Initialiaation du client SOAP $client = new soapclient($wsdl,array('trace' =>1)); //Définition du cookie qui sera envoyé avec la requête SOAP $client-> setcookie('jsessionid', $JSESSIONID); finalizewiththreeds function call </body> Network- 16/ 79

21 Handle the authentication result and complete the transaction 1. Get the PaRes message and the field MD sent to your TermUrl. 2. Extract the value of JSESSIONID and threedsrequestid form the field MD. 3. Proceed with the signature computation. 4. Set a new cookie called JSESSIONID with the value extracted previously and call the finalyzewithtreeds() method, passing in threedsrequestid and pares field. 5. Systempay returns a transactioninfo object. Check for the value of the errorcode field. o o If the errorcode value is 0, read the other values returned in the transactioninfo object such as transactionstatuslabel. If the errorcode value is not 0, then process the errors. wssignature = SHA1(threeDSRequestId+pares+certificate) Request header [Request Header] POST /vads-ws/v4.3 HTTP/1.1 Host: paiement.systempay.fr Connection: Keep-Alive User-Agent: PHP-SOAP/ Content-Type: text/xml; charset=utf-8 SOAPAction: "" Content-Length: 5332 Cookie: JSESSIONID=F F7C69B419344A577959C9BA.bdxvad2; SOAP Request example <ns1:finalizewiththreeds> <threedsrequestid>_cc ac6-48d6-b07d-3eb3618cb0df</threedsrequestid> <pares>ejznwdmszv2xwkt237ljp9dzctesdnagpd/xyxfy58h+bbdankg1ufuxbwk/wqdnbdn</pares> <wssignature>e92d7e22d10076c4e67fbadc631c6a2898c43eac</wssignature> Network- 17/ 79

22 7.3. Create a transaction without 3D-Secure authentication 1. Create a new paymentcreationinfo objet. 2. Populate at least all of the required fields for the paymentgeneralinfo object. 3. Populate at least all of the required fields for the cardinfo object. 4. Do not populate the threedsresult object. 5. Populate at least all of the required fields for the extrainfo object. 6. If you need, you can use some optional fields. Refer to the create method description s section. 7. Proceed with the signature computation (see below). 8. Call the create() method, passing in the paymentcreationinfo object created in the previous steps and the wssignature field. 9. Systempay returns a transactioninfo object. Check for the value of the errorcode field. o o If the errorcode value is 0, read the other values returned in the transactioninfo object such as transactionstatuslabel. If the errorcode value is not 0, then process the errors. Example This example show how to create a payment without 3D-Secure authentication. validationmode and presentationdate are used as optional fields. threedsresult, subpaymentinfo, customerinfo, shippinginfo are not populated in the request. Their value in the signature computation will be empty. wssignature = SHA1(siteId+transactionId+paymentSource+orderId+orderInfo+orderInfo2+orderInfo3 +amount+currency+validationmode+cardnumber+cardnetwork+expirymonth +expiryyear+cvv+cardident+cardbirthday+contractnumber+paymentoptioncode +threedsresult+subpaymentinfo+custormerinfo+shippinginfo +ctxmode+browesruseragent+browseraccept+certificate) wssignature = SHA1( EC+cmde-test VISA Network- 18/ 79

23 SOAP Example <ns1:create> <createinfo> <paymentgeneralinfo> <siteid> </siteid> <transmissiondate> t09:46:56+00:00</transmissiondate> <transactionid>388160</transactionid> <paymentsource>ec</paymentsource> <orderid>cmde-test</orderid> <amount>12500</amount> <currency>978</currency> <presentationdate> t09:46:56+00:00</presentationdate> <validationmode>1</validationmode> </paymentgeneralinfo> <cardinfo><cardnumber> </cardnumber> <cardnetwork>visa</cardnetwork> <expirymonth>12</expirymonth> <expiryyear>2021</expiryyear> <cvv>111</cvv> </cardinfo> <extrainfo> <ctxmode>test</ctxmode> </extrainfo></createinfo> <wssignature>97fd9257bb87ae03dcf58660b2292ee2e </wssignature> Network- 19/ 79

24 7.4. Create a payment with 3D-Secure handled by merchant s MPI plugin 1. Create a new paymentcreationinfo objet. 2. Populate at least all of the required fields for the paymentgeneralinfo object. 3. Populate at least all of the required fields for the cardinfo object. 4. Populate at least all of the required fields for the threedsresult object with the result of the payer authentication performed by the merchant: threedsbrand threedsenrolled threedsstatus, only if threedsenrolled = Y threedsxid, only if threedsenrolled = Y threedseci, only if threedsenrolled = Y AND threedsstatus = Y or A threedscavv, only if threedsenrolled = Y AND threedsstatus = Y or A threedscavvalgorithm, only if threedsenrolled = Y AND threedsstatus = Y or A 5. Populate at least all of the required fields for the extrainfo object. 6. If you need, you can use some optional fields. Refer to the create method description s section. 7. Proceed with the signature computation (see below). 8. Call the create() method, passing in the paymentcreationinfo object created in the previous steps and the wssignature field. 9. Systempay returns a transactioninfo object. Check for the value of the errorcode field. o o If the errorcode value is 0, read the other values returned in the transactioninfo object such as transactionstatuslabel. If the errorcode value is not 0, then process the errors. Example This example show how to create a payment after the payer has been successfully authenticated by the ACS. validationmode and presentationdate are used as optional fields. subpaymentinfo, customerinfo, shippinginfo are not populated in the request. Their value in the signature computation will be empty. wssignature = SHA1(siteId+transactionId+paymentSource+orderId+orderInfo+orderInfo2+orderInfo3 +amount+currency+validationmode+cardnumber+cardnetwork+expirymonth +expiryyear+cvv+cardident+cardbirthday+contractnumber+paymentoptioncode +threedsbrand+threedsenrolled+threedsstatus+threedseci+threedsxid +threedscavv+threedscavvalgorithm+subpaymentinfo+custormerinfo+shippinginfo +ctxmode+browesruseragent+browseraccept+certificate) wssignature = SHA1( EC+cmde-test VISA VISA+Y+Y+05+VXJjeXY0VXZWUjRsWWJaOUo4b3A= +Q2F2dkNhdnZDYXZ2Q2F2dkNhdnY=+2+++ Network- 20/ 79

25 SOAP Example <ns1:create> <createinfo> <paymentgeneralinfo> <siteid> </siteid> <transmissiondate> t15:59:54+00:00</transmissiondate> <transactionid>611949</transactionid> <paymentsource>ec</paymentsource> <orderid>cmde-test</orderid> <amount>12500</amount> <currency>978</currency> <presentationdate> t15:59:54+00:00</presentationdate> <validationmode>1</validationmode> </paymentgeneralinfo> <cardinfo> <cardnumber> </cardnumber> <cardnetwork>visa</cardnetwork> <expirymonth>12</expirymonth> <expiryyear>2021</expiryyear> <cvv>111</cvv> </cardinfo> <threedsresult> <threedsbrand>visa</threedsbrand> <threedsenrolled>y</threedsenrolled> <threedsstatus>y</threedsstatus> <threedseci>05</threedseci> <threedsxid>vxjjexy0vxzwujrswwjaouo4b3a=</threedsxid> <threedscavv>q2f2dknhdnzdyxz2q2f2dknhdny=</threedscavv> <threedscavvalgorithm>2</threedscavvalgorithm> </threedsresult> <extrainfo> <ctxmode>test</ctxmode> </extrainfo> </createinfo> <wssignature>fb1c d10179cb33b6794e55db905</wssignature> Network- 21/ 79

26 7.5. Update a transaction The following fields are required: siteid transmissiondate transactionid sequencenumber ctxmode amount currency presentationdate validate comment wssignature SOAP Code <ns1:modify> <siteid> </siteid> <transmissiondate> t08:09:22+00:00</transmissiondate> <transactionid>965805</transactionid> <sequencenumber>1</sequencenumber> <ctxmode>test</ctxmode> <amount>15800</amount> <currency>978</currency> <presentationdate> t08:09:22+00:00</presentationdate> <validate>true</validate> <comment></comment> <wssignature>532bfc85fac7b4af69323e b c62</wssignature> </ns1:modify> wssignature = SHA1(siteId+transactionId+sequenceNumber+ctxMode Network- 22/ 79

27 7.6. Cancel a transaction The following fields are required: siteid transmissiondate transactionid sequencenumber ctxmode comment wssignature SHA1 (siteid+transactionid+sequencenumber+ctxmode+comment+certificate) SOAP Example <ns1:cancel> <siteid> </siteid> <transmissiondate> t14:15:19+00:00</transmissiondate> <transactionid>549195</transactionid> <sequencenumber>1</sequencenumber> <ctxmode>test</ctxmode> <comment/> <wssignature>c c0dc0f2dfbfdd28e45c5e4e3b4c6e84</wssignature> </ns1:cancel> SOAP Example Response <ns1:cancelresponse xmlns:ns1=' <return> <timestamp> </timestamp> <signature>37aac278bf5e6f305708aebf a620c2771</signature> <errorcode>0</errorcode> <transactionstatus>9</transactionstatus> </return> Network- 23/ 79

28 7.7. Refund a transaction The following fields are required: siteid transmissiondate transactionid sequencenumber ctxmode newtransactionid amount currency presentationdate comment wssignature wssignature = SHA1 (siteid+transactionid+sequencenumber+ctxmode +newtransactionid+amount+currency+validationmode +comment+certificate) SOAP Example <ns1:refund> <siteid> </siteid> <transmissiondate> t15:21:02+00:00</transmissiondate> <transactionid>594750</transactionid> <sequencenumber>1</sequencenumber> <ctxmode>test</ctxmode> <newtransactionid>570152</newtransactionid> <amount>90</amount> <currency>978</currency> <presentationdate> t14:50:15+00:00</presentationdate> <validationmode>1</validationmode> <comment>remboursement partiel</comment> <wssignature>c6e8cf8b4445e9a8c263d fb0ef59b0</wssignature> Network- 24/ 79

29 7.8. Duplicate a transaction The following fields are required: siteid transmissiondate transactionid sequencenumber ctxmode orderid orderinfo (can be empty) orderinfo2 (can be empty) orderinfo3 (can be empty) amount currency newtransactionid presentationdate validationmode comment wssignature wssignature = SHA1(siteId+transactionId+sequenceNumber+ctxMode+orderId+orderInfo +orderinfo2+orderinfo3+amount+currency+newtransactionid+validationmode +comment+certificate) SOAP Example <ns1:duplicate> <siteid> </siteid> <transmissiondate> t14:15:19+00:00</transmissiondate> <transactionid>549195</transactionid> <sequencenumber>1</sequencenumber> <ctxmode>test</ctxmode> <orderid>cmde-test</orderid> <orderinfo/> <orderinfo2/> <orderinfo3/> <amount>34000</amount> <currency>978</currency> <newtransactionid>625424</newtransactionid> <presentationdate> t16:22:22+00:00</presentationdate> <validationmode>1</validationmode> <comment/> <wssignature>da962cd70b7121dbedfd6b7a44ac580e66f17614</wssignature> Network- 25/ 79

30 7.9. Retrieve a transaction The following fields are required: siteid transmissiondate transactionid sequencenumber ctxmode wssignature wssignature = SHA1 (siteid+transactionid+sequencenumber+ctxmode+certificate) SOAP Example <ns1:getinfo> <siteid> </siteid> <transmissiondate> t14:15:19+00:00</transmissiondate> <transactionid>549195</transactionid> <sequencenumber>1</sequencenumber> <ctxmode>test</ctxmode> <wssignature>e0823f7326d94d bccc2e9e1472ff5ad9</wssignature> Network- 26/ 79

31 7.10. Validate a transaction The following fields are required: siteid transmissiondate transactionid sequencenumber ctxmode comment wssignature wssignature = SHA1 (siteid+transactionid+sequencenumber+ctxmode+comment+certificate) SOAP Example <ns1:validate> <siteid> </siteid> <transmissiondate> t16:31:15+01:00</transmissiondate> <transactionid>594750</transactionid> <sequencenumber>1</sequencenumber> <ctxmode>test</ctxmode> <comment/> <wssignature>2b2a2775b8ddf9525d034ba32dd2313ad9801bd1</wssignature> </ns1:validate> SOAP Example Response <ns1:validateresponse xmlns:ns1=' <return> <timestamp> </timestamp> <signature>05d9f8a28a740df9f55b9b c962a6169ae</signature> <errorcode>0</errorcode> <transactionstatus>4</transactionstatus> </return> Network- 27/ 79

32 8. Methods createwiththreeds() Use createwiththreeds() to verify if cardholder participates in 3D-Secure program, and generates the Payer Authentication Request message. If cardholder is not enrolled, PayZen submits a traditional authorization request and create a new transaction. Arguments Mandatory Name Data Type Description Field createinfo createpaymentinfo Payment request message wssignature String Signature (see below) Use the following fields in this order: createpaymentinfo.paymentgeneralinfo, createpaymentinfo.cardinfo, createpaymentinfo.subpaymentinfo, createpaymentinfo.customerinfo, createpaymentinfo.shippinginfo, createpaymentinfo.extrainfo Returns Returns a createwiththreedsresponse object. If the card is enrolled, the response contains a verespareqinfo object. Otherwise, the response contains a transactioninfo Network- 28/ 79

33 finalyzewiththreeds() Use finalyzewiththreeds() to: return the response from 3D-Secure server, back to the payment gateway complete the transaction Arguments Name threedsrequestid Data Type String Description This is the threedsrequestid (extracted from the MD parameter returned from ACS Server) pares String Returned parameter from ACS Server Mandatory Field wssignature String Signature (see below) Use the following fields in this order: threedsrequestid, pares Returns Returns a transactioninfo object. Note : The PARes message can contain newline characters ( CR, LF ou \r, \n ). Some systems replace these characters by a LF character in the SOAP message. It is the case in particular in ASP.NET To avoid signature computation problem, we recommend to delete newline characters and white spaces, both finalyzewiththreeds request and in the signature computation. This does not alter the integrity of the PARes Network- 29/ 79

34 create() Use create() to create: a single payment without 3D-Secure authentication a single payment with 3D-Secure handled by merchant s MPI plugin a payment by ID without 3D-Secure a payment by ID with 3D-Secure handled by merchant s MPI plugin. Arguments Mandatory Name Data Type Description Field createinfo paymentcreationinfo Payment request message wssignature String Signature (see below) Use the following fields in this order: paymentcreationinfo.paymentgeneralinfo, paymentcreationinfo.cardinfo, paymentcreationinfo.threedsresult, paymentcreationinfo.subpaymentinfo, paymentcreationinfo.customerinfo, paymentcreationinfo.shippinginfo, paymentcreationinfo.extrainfo Returns Returns a transactioninfo Network- 30/ 79

35 modify() Use modify() to: modify the amount of a transaction (only with a smaller value) modify the day of capture validate the transaction Transactions must have one of the following statuses (Transaction statuses): AUTHORISED_TO_VALIDATE WAITING_AUTHORISATION_TO_VALIDATE WAITING_AUTHORISATION AUTHORISED This method will return an error: when called with an incorrect value of amount (null, 0, or greater than the original amount), when called with the same values for amount, day of capture and validation mode, as the original values. Arguments Mandatory Name Data type Description Field siteid String / n8 Shop ID transmissiondate datetime / ans..40 Date and time of creation of the transaction to be modified, according to the W3C guidelines. E.g T08:16:43+00:00 transactionid String / an6 Unique ID of the transaction to modify Sequence number of the transaction to be modified. sequencenumber Int / n..3 Values: 1 for a single payment. The number of term in the case of an installment payment ctxmode String Indicates if the request is made in test mode or live mode. (Expected value: TEST or PRODUCTION ) amount Long / n..12 Transaction amount. Positive integer, smallest possible unit per currency (for euro, we re calculating the amount in cents) If you do not wish to modify the amount of the transaction, you have to populate this field with the initial amount value. currency Int / n3 Currency code according to the ISO 4217 standard (e.g «978» for EURO) Defines the day of automatic capture of an datetime / presentationdate authorized payment, according to the W3C ans..40 guidelines (e.g T08:16:43+00:00 validate bool Indicates if you want to validate the transaction. 0 = NO, 1 = YES comment String Use this field to record comments about the payment. wssignature String Signature (see Network- 31/ 79

36 Use the following fields in this order: siteid, transactionid, sequencenumber, ctxmode, amount, currency, validate, comment Returns Returns a transactioninfo Network- 32/ 79

37 cancel() Use cancel() to cancel definitely a transaction not captured yet. Transactions must have one of the following statuses (Transaction statuses): AUTHORISED_TO_VALIDATE WAITING_AUTHORISATION_TO_VALIDATE WAITING_AUTHORISATION AUTHORISED Arguments Name Data Type Description Mandatory Field siteid String / n8 Shop ID transmissiondate datetime / ans..40 sequencenumber Int / n..3 Date and time of creation of the transaction to be cancelled, according to the W3C guidelines. E.g T08:16:43+00:00 transactionid String / an6 Unique ID of the transaction to cancel Sequence number of the transaction to be cancelled. Values: ctxmode String 1 for a single payment. The number of term in the case of an installment payment Indicates if the request is made in test mode or live mode (Expected value: TEST or PRODUCTION ) comment String Use this field to record comments about the payment. wssignature String Signature (see below) Use the following fields in this order: siteid, transactionid, sequencenumber, ctxmode, comment Returns Returns a standardresponse Network- 33/ 79

38 refund() Use refund() to refund a transaction that has previously been captured. You can either refund the full amount of the debit or you can issue a partial refund. You can do so as many times as you wish until the entire transaction has been refunded. Once entirely refunded, a transaction can t be refunded again. Refund operation may be refused if the credit card expiry date is exceeded. This method will return an error: when called on a transaction that has been not yet captured when called on an already-refunded transaction when trying to refund more money than is left Transactions must have the following statuses (Transaction statuses): CAPTURED Arguments Name Data Type Description Mandatory Field siteid String / n8 Shop ID transmissiondate transactionid datetime / ans..40 String / an6 sequencenumber Int / n..3 ctxmode String newtransactionid String / an6 Date and time of creation of the transaction to be refunded, according to the W3C guidelines. E.g T08:16:43+00:00 Unique ID of the transaction to refund (Initial transaction) Sequence number of the transaction to be refunded. Values: 1 for a single payment. The number of term in the case of an installment payment Indicates if the request is made in test mode or live mode (Expected value: TEST or PRODUCTION ) Unique ID of the transaction generated by the merchant. amount Long / n..12 Amount of the refund. currency presentationdate validationmode comment Int / n3 datetime / ans..40 Int / n..1 String Currency code according to the ISO 4217 standard (e.g «978» for EURO) Defines the day of automatic capture of an authorized payment, according to the W3C guidelines (e.g T08:16:43+00:00 Payment validation mode 0= Automatic ; 1= Manual Use this field to record comments about the payment. wssignature String Signature (see Network- 34/ 79

39 Use the following fields in this order: siteid, transactionid, sequencenumber, ctxmode, newtransactionid, amount, currency, validationmode, comment Returns Returns a transactioninfo Network- 35/ 79

40 duplicate() Use duplicate() on an existing transaction to create a new transaction with the same characteristics. Transactions must have one of the following statuses (Transaction statuses): CAPTURED EXPIRED CANCELLED REFUSED Arguments Name Data Type Description Mandatory Field siteid String Shop ID transmissiondate transactionid datetime / ans..40 String / an6 sequencenumber Int / n..3 ctxmode String Date and time of creation of the transaction to be duplicated, according to the W3C guidelines. E.g T08:16:43+00:00 Unique ID of the transaction to be duplicated (Initial transaction) Sequence number of the transaction to be duplicated. Values: 1 for a single payment. The number of term in the case of an installment payment Indicates if the request is made in test mode or live mode (Expected value: TEST or PRODUCTION ) orderid String / ans..64 Order reference orderinfo String orderinfo2 String Order description orderinfo3 String amount Long / n..12 Transaction amount. Positive integer, smallest possible unit per currency (for euro, we re calculating the amount in cents) currency Int / n3 Currency code according to the ISO 4217 standard (e.g «978» for EURO) newtransactionid String / an6 Unique ID of the transaction, generated by the merchant. Defines the day of automatic capture of an datetime / presentationdate authorized payment, according to the W3C ans..40 guidelines (e.g T08:16:43+00:00 validationmode Int / n..1 Payment validation mode 0= Automatic ; 1= Manual comment String Use this field to record comments about the payment. wssignature String Signature (see Network- 36/ 79