Introduction

WL Sips is a secure multi-channel e-commerce payment solution that complies with the PCI DSS standard. It allows you to accept and manage payment transactions by taking into account business rules related to your activity (payment on despatch, deferred payment, recurring payment, payment in instalments, etc.).

The purpose of this document is to explain the implementation steps of the Sips Walletpage POST solution up to live operations.

Who does this document target?

This document is intended for merchants wishing to subscribe to the WL Sips offer and use a connector based on HTTPS exchanges in POST mode between their websites and the WL Sips servers, so as to enable their customers to manage their OneClick or subscriber wallets.

It is an implementation guide for your technical team.

To get an overview of the WL Sips solution, we advise you to consult the following documents:

  • Functional presentation
  • Functionality set-up guide
  • OneClick payment
  • Subscription payment

Prerequisites

Knowledge of standards related to web programming languages used today, such as Java, PHP or .Net, is necessary to develop a connection to Sips Walletpage POST .

Note: all code sections in this document are provided as samples, you will need to adapt them to your website for them to be fully operable.

Secret key management

Upon your subscription, Worldline provides a secret key on the Sips Download extranet that will allow you to secure exchanges between your website and the WL Sips server.

You are responsible for looking after this key and should take all measures to:

  • Restrict access to the key
  • Safeguard it by encrypting it
  • Never copy it onto a non-secure disc or device
  • Never send it (via e-mail or regular mail) in a non-secure method.

A secret key compromised (and used by a malicious third party) might disrupt the regular operation of your shop and might in particular generate unauthorised sales or cash transactions (e.g. refunds).

IMPORTANT: in the event that a secret key is compromised, you are required to ask as quickly as possible for its revocation then for its renewal via the Sips Download extranet (please refer to the "Secret key revocation and renewal" section in the Quick start guide).

The very same secret key is used on the various Sips Paypage , Sips Office , Sips In-App and Sips Walletpage connectors.

IMPORTANT: a secret key is associated with a version. After getting a new secret key, you must modify your request and populate the keyVersion field with the new version, otherwise you will get an answer code 34 (suspected fraud).

Contacting the support

For any technical question or request for assistance, our services are available:

  • by telephone at: +33 (0) 811 10 70 33
  • by e-mail: sips@worldline.com

In order to facilitate the processing of your requests, please provide your merchantId (15-digit number).

Understanding customer wallet management with Sips Walletpage POST

The wallet management process works as follows:

1. When the customer initiates the wallet management step, a request must be sent to the Sips Walletpage POST connector the URL of which is provided by Worldline . The request is then checked, and encrypted if it is valid (it is named RedirectionData in the system). The request is sent through a POST form via HTTPS. Any other solution that can sends such requests also works.

2. The merchant's website redirects the calling application to the wallet management interface, with the encrypted request. The latter is decrypted, and Sips Walletpage enables the customer to perform various operations on their wallet. For the customer to be able to return to your site, a response is created and sent to the response URL provided in workflow No. 1.

There are two independent response notifications:

3. The wallet management server sends the manual response to the manual response URL using the HTTP(S) POST method. This URL is supplied in the wallet management request when the customer clicks on the “Back to shop” button or link on the wallet management page. This is why the normal response URL is also the page the customer is redirected to when wallet management operations are over. As nothing guarantees that the customer will click on this link, the receipt of the manual response cannot be guaranteed either.

4. Automatic responses are sent separately from manual responses. They also use the HTTP(S) POST requests sent by the wallet management servers, but this time, they use the automatic response URL specified in the wallet management request. You will receive the response when the customer clicks on the “Back to shop” button or if the wallet management session expires.

Getting started with Sips Walletpage POST in 5 steps

Step 1: subscribing to the service

If your shop has not been registered yet, you must fill in the registration form (asking for the subscription service or the OneClick service) sent by Worldline and send it back to them.

If your shop has already been registered with WL Sips , you need to ask the technical contact to activate the subscription service or the OneClick service.

Note: if your wallet database is shared between several shops, you must specify it in your registration form or tell it to the technical support team.

If this information is not supplied, WL Sips defines a dedicated wallet database for your shop.

Step 2: managing your customers' wallets

The wallet management request is a HTTPS POST request sent to the wallet management connector. You must send the request via an HTML form using the POST method.

Generating the wallet management request

Three essential data are specified in wallet management requests:

Data element name Description
Data Contains all the information related to the management of the wallet.
InterfaceVersion Defines the version of the request and of the response exchanged with the WL Sips server.
Seal Used to validate the integrity of data exchanged. The Seal data element is computed using the Data data element and the secret key.

The value of the InterfaceVersion data element must be set to HP_ 2.6 .

Additional optional data are available:

Data element name Description
Encode Specifies the method used to encode the Data data element.
SealAlgorithm Specifies the algorithm used to compute the Seal data element.

Data field syntax

The Data field is structured in compliance with the following format:

      <fieldName1>=<fieldValue1>|<fieldName2>=<fieldValue2>|…|<fieldNameN>=<fieldValueN>
    

All fields required for the wallet management (see details in the data dictionary) should be included in the character string. The order of the fields is irrelevant.

Sample wallet management request:
      merchantId=011223744550001|normalReturnUrl=http://www.normalreturnurl.com|merchantWalletId=w5346|keyVersion=1|requestDateTime=2015-08-05T16:18:09.415+02:00
    

A field can have several values:

      ..|fieldName=value1,value2, … ,valueX|…
    

Sample paymentMeanBrandList field with VISA and MASTERCARD as values:

      …|normalReturnUrl=https://www.normalreturnurl.com|merchantId=201010314150000|keyVersion=1|merchantWalletId=2|paymentMeanBrandList=VISA,MASTERCARD|requestDateTime=2017-05-26T11:09:01.487+02:00|keyVersion=1|…
    

If the field is a container, you must use a dot between the container name and the field name:

      ..|Container.fieldName1=fieldValue1|container.fieldName2=fieldValue2|……
    

Sample customerContact field containing the customer's e-mail (me@email.com), last name and first name (John Smith):

      …|customerContact.email=me@email.com|customerContact.firstname=John|customerContact.lastname=Smith|…
    

Encoding the Data field

The Data field should be encoded using base64 or base64Url if it contains special characters (such as accented characters).

Note: since the signature is computed using the Data field, please note that it is the encoded Data value which is used for the request signature.

Securing the request

The request includes the transaction parameters and is sent by the customer's web browser. Theoretically, a third party can intercept the request and modify its content before the data reaches the payment server.

Therefore it is necessary to strengthen security so as to ensure the integrity of the parameters of the transaction sent. The WL Sips solution meets this challenge by exchanging signatures. An effective signature control comprises two elements:

  • The integrity of the request and response messages.
  • The issuer and recipient authentication, as they share the same secret key.
IMPORTANT: if your secret key is compromised, or if you suspect this might be the case, you should always go to Sips Download to request a new one.

How to secure the request

The request is secured by calculating the hash value in line with the transaction parameters. Then, the secret key is added to it. All character strings are converted to UTF-8 before being hashed.

The hashing algorithm generates an irreversible result. When such a message is received, the recipient needs to recalculate the hash value and compare it with the one received. Any difference indicates that the data exchanged was falsified, or that the recipient and the issuer do not share the same secret key.

The result must be sent in hexadecimal format in the data element named Seal .

Calculating the Seal data element

HMAC-SHA algorithm

The value of the Seal data element is computed as follows:

  • Content of the Data field sent in the POST form. Giving the data , mentioned in the examples below.
  • UTF-8 encoding of data from the previous result.
  • HMAC with SHA256 encryption of bytes obtained with the secret key.

This procedure can be summarised as follows:

      HMAC-SHA256( UTF-8(Data), UTF-8(secretKey))
    
Note: by default, the seal is calculated with the SHA-256 algorithm, for a seal to be computed with the HMAC-SHA-256 algorithm, the input parameters of the request must include the sealAlgorithm field populated with the following value: “HMAC-SHA-256”.
Hmac Sha256 sample code
  • Sample Hmac Sha256 encoding in Php 5
            
    <?php
    
    …
    
    // Seal computation thanks to hash sorted data hash with merchant key
    
    $data_to_send= utf8_encode($data)
    
    $seal=hash_hmac('sha256', $data_to_send, $secretKey);
    
    …
    …
    
    ?> 
          

    data_to_send and secretKey must use a UTF-8 character set. Please refer to the utf8_encode function for the conversion of ISO-8859-1 characters in UTF-8.

  • Sample Hmac Sha256 encoding in Java
            
    import java.security.InvalidKeyException;
    import java.security.NoSuchAlgorithmException;
    
    import javax.crypto.Mac;
    import javax.crypto.spec.SecretKeySpec;
    
    public class ExampleHMACSHA256 {
    
    /**
     * table to convert a nibble to a hex char.
     */
    static final char[] hexChar = {
       '0' , '1' , '2' , '3' ,
       '4' , '5' , '6' , '7' ,
       '8' , '9' , 'a' , 'b' ,
       'c' , 'd' , 'e' , 'f'};
    
    /**
     * Fast convert a byte array to a hex string
     * with possible leading zero.
     * @param b array of bytes to convert to string
     * @return hex representation, two chars per byte.
     */
    public static String encodeHexString ( byte[] b )
       {
       StringBuffer sb = new StringBuffer( b.length * 2 );
       for ( int i=0; i<b.length; i++ )
          {
          // look up high nibble char
          sb.append( hexChar [( b[i] & 0xf0 ) >>> 4] );
    
          // look up low nibble char
          sb.append( hexChar [b[i] & 0x0f] );
          }
       return sb.toString();
       }
    
    /**
     * Computes the seal
     * @param Data the parameters to cipher
     * @param secretKey the secret key to append to the parameters 
     * @return hex representation of the seal, two chars per byte.
     */
    public static String computeSeal(String data, String secretKey) throws Exception
    {
      Mac hmacSHA256 = Mac.getInstance("HmacSHA256");
      SecretKeySpec keySpec = new SecretKeySpec(secretKey.getBytes(), "HmacSHA256");
      hmacSHA256.init(keySpec);
    
      return encodeHexString(hmacSHA256.doFinal(data.getBytes()));
    }
    
    /**
     * @param args
     */
    public static void main(String[] args) {
    try {
    System.out.println (computeSeal("parameters", "key"));
    } catch (Exception e) {
    e.printStackTrace();
    }
    }
    
    }
          
  • Sample Hmac Sha256 encoding in .net

    (Carried out using a simple form called "Form1" containing two text fields to enter data and txtSecretKey , and another field to display  lblHEX ).

            
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;
    using System.Data;
    using System.Drawing;
    using System.Text;
    using System.Windows.Forms;
    using System.Security.Cryptography;
    
    namespace ExampleDotNET
    {
        public partial class Form1 : Form
        {
            public Form1()
            {
                InitializeComponent();
            }
    
            private void cmdGO_Click(object sender, EventArgs e)
            {
                String sChaine = data.Text;
                UTF8Encoding utf8 = new UTF8Encoding();
                Byte[] encodedBytes = utf8.GetBytes(sChaine);
            
                byte[] shaResult;
                
                HMAC hmac = new HMAC.Create("HMACSHA256");
                var key = "YourSecretKey";
                hmac.Key = utf8.GetBytes(key); 
                hmac.Initialize();
    
                shaResult = hmac.ComputeHash(encodedBytes);
    
                lblHEX.Text = ByteArrayToHEX(shaResult);
            }
    
            private string ByteArrayToHEX(byte[] ba)
            {
                StringBuilder hex = new StringBuilder(ba.Length * 2);
                foreach (byte b in ba)
                    hex.AppendFormat("{0:x2}", b);
                return hex.ToString();
            }
    
        }
    }
          
Seal calculation validation

Once you have set up your seal calculation, here is a sample request to help you verify that you find the correct seal:

      automaticResponseURL=https://automatic-response-url.fr/|normalReturnUrl=https://normal-return-url/|merchantId=011223344550000|keyVersion=1|merchantWalletId=wallet01|requestDateTime=2018-08-08T16:29:19.619+02:00|customerContact.email=customer@email.com

    

For the above request, with a HMAC-SHA-256 hash algorithm and the following secret key:

      secret123
    

The expected seal is:

      406fa400c74ab8a2c4ad2801ec9d216991a8af4751059b3766157914cddf7912
    
SHA-256 algorithm

The value of the Seal data element is computed as follows:

  • Concatenation of the Data field element and of the secret key (encoded if the corresponding option is selected).
  • UTF-8 encoding of the data constituting the result of the previous operation.
  • SHA256 hashing of bytes obtained.

This procedure can be summarised as follows:

      SHA256( UTF-8(Data+secretKey ) )
    
Sample Sha256 code
  • Sample Sha256 encoding in Php 5
      <?php
echo hash('sha256', $data.$secretKey);
?> 
    

The UTF-8 character set should be used for the Data and secretKey data. To convert ISO-8859-1 to UTF-8, use the utf8_encode function.

  • Sample Sha256 encoding in Java
      import java.security.MessageDigest;

public class ExampleSHA256 {

/**
 * table to convert a nibble to a hex char.
 */
static final char[] hexChar = {
   '0' , '1' , '2' , '3' ,
   '4' , '5' , '6' , '7' ,
   '8' , '9' , 'a' , 'b' ,
   'c' , 'd' , 'e' , 'f'};

/**
 * Fast convert a byte array to a hex string
 * with possible leading zero.
 * @param b array of bytes to convert to string
 * @return hex representation, two chars per byte.
 */
public static String encodeHexString ( byte[] b )
   {
   StringBuffer sb = new StringBuffer( b.length * 2 );
   for ( int i=0; i<b.length; i++ )
      {
      // look up high nibble char
      sb.append( hexChar [( b[i] & 0xf0 ) >>> 4] );

      // look up low nibble char
      sb.append( hexChar [b[i] & 0x0f] );
      }
   return sb.toString();
   }

/**
 * Computes the seal
 * @param Data the parameters to cipher
 * @param secretKey the secret key to append to the parameters 
 * @return hex representation of the seal, two chars per byte.
 */
public static String computeSeal(String Data, String secretKey) throws Exception
{
  MessageDigest md = MessageDigest.getInstance("SHA-256");
  md.update((Data+secretKey).getBytes("UTF-8"));

  return encodeHexString(md.digest());
}

/**
 * @param args
 */
public static void main(String[] args) {
try {
System.out.println (computeSeal("parameters", "key"));
} catch (Exception e) {
e.printStackTrace();
}
}
}
    
  • Sample Sha256 encoding in .NET

Completed using a simple form called "Form 1" containing two text fields to be filled in: data, txtSecretKey and another one to be displayed: lblHEX .

      using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using System.Security.Cryptography;

namespace ExampleDotNET
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void cmdGO_Click(object sender, EventArgs e)
        {
            String sChaine = data.Text + txtSecretKey.Text;
            UTF8Encoding utf8 = new UTF8Encoding();
            Byte[] encodedBytes = utf8.GetBytes(sChaine);
        
            byte[] shaResult;
            SHA256 shaM = new SHA256Managed();
            shaResult = shaM.ComputeHash(encodedBytes);

            lblHEX.Text = ByteArrayToHEX(shaResult);
        }

        private string ByteArrayToHEX(byte[] ba)
        {
            StringBuilder hex = new StringBuilder(ba.Length * 2);
            foreach (byte b in ba)
                hex.AppendFormat("{0:x2}", b);
            return hex.ToString();
        }

    }
}
    

Sample wallet management request

Below is a sample form with the Data field unencoded:

      <form method="post" action="https://url.to.sips.server/walletManagementInit">
    <input type="hidden" name="Data" value=" merchantId=011223744550001|normalReturnUrl=http://www.normalreturnurl.com| merchantWalletId=w53465|keyVersion=1|requestDateTime=2015-08-05T16:18:09.415+02:00 ">
    <input type="hidden" name="InterfaceVersion" value="HP_2.4">
    <input type="hidden" name="Seal" value="21a57f2fe765e1ae4a8bf15d73fc1bf2a533f547f2343d12a499d9c0592044d4">
    <input type="submit" value="Gérer son wallet">   
</form>
    

Processing wallet management initialisation errors

All fields received by Sips Walletpage POST through the connector are checked individually. The table below lists the error messages that might be displayed during this step, and the solutions to be implemented.

Note: messages are displayed on the simulation platform to help you validate the integration of your website. For security reasons, much simpler error messages are displayed on the production platform. Example: "Error when processing the request. Contact your merchant".
Message Cause Solution
Unknown interface version: <version> The <version> value in the InterfaceVersion field is unknown. Check the interface version in this user guide.
Invalid keyword: <fieldName>= <fieldValue> The <fieldName> field is not expected in the request. Check the field names in the sections below and in the data dictionary.
Invalid field size: <fieldName>= <fieldValue> The <fieldName> field is of incorrect length. Check the field length in the data dictionary.
Invalid field value: <fieldName >= <fieldValue> The value of the <fieldName> field is not correct. Check the values available for this field in the data dictionary.
Mandatory field missing: <fieldName > The <fieldName> field is missing in the request. Check the mandatory fields of the request in the sections below.
Unknown security version: <version> The <version> value in the keyVersion field is unknown. Check the versions of keys available in Sips Download .
Invalid signature The checking of the of the request seal has failed. This may be caused by an incorrect computing of the seal data or may indicate the falsification of some fields after the computing of the signature. Check that the Seal is computed as indicated in the above section. If it is, ask for a new secret key via Sips Download because the request has been falsified.
<Other messages> In the case of technical errors, various messages may be displayed. Please contact the technical support.

Populating the request fields

Generic fields

Field Presence As of Version Comments
customerId Optional HP_ 2.0
customerIpAddress Optional HP_ 2.0
customerLanguage Optional HP_ 2.0
interfaceVersion Mandatory HP_ 2.0
merchantId Mandatory HP_ 2.0
merchantSessionId Optional HP_ 2.0
merchantWalletId Mandatory HP_ 2.0
normalReturnUrl Mandatory HP_ 2.0
automaticResponseURL Optional HP_ 2.0
paymentMeanBrandList Optional HP_ 2.0
walletActionNameList Optional HP_ 2.0
requestDateTime Mandatory HP_ 2.0 It is the date and time of which the request is sent. The date and time between Sips receives the request and requestDateTime should not exceed 2 minutes; otherwise the request will be refused.
responseKeyVersion Optional HP_ 2.0
returnContext Optional HP_ 2.0
templateName Optional HP_ 2.0
billingAddress Optional HP_ 2.0 See the Containers part
billingContact Optional HP_ 2.0 See the Containers part
customerAddress Optional HP_ 2.0 See the Containers part
customerContact Optional HP_ 2.0 See the Containers part
customerData Optional HP_ 2.0 See the Containers part
deliveryAddress Optional HP_ 2.0 See the Containers part
deliveryContact Optional HP_ 2.0 See the Containers part
fraudData Optional HP_ 2.0 See the Containers part
holderAddress Optional HP_ 2.0 See the Containers part
holderContact Optional HP_ 2.0 See the Containers part
holderData Optional HP_ 2.0 See the Containers part
paymentMeanData Optional HP_ 2.4 See the Containers part
intermediateServiceProviderId Optional HP_ 2.2
seal Mandatory HP_ 2.2
keyVersion Mandatory HP_ 2.2
sealAlgorithm Optional HP_ 2.2
mandateId Optional HP_ 2.4
transactionActors Optional HP_ 2.4
responseEncoding Optional HP_ 2.5
merchantName Optional HP_ 2.6
merchantUrl Optional HP_ 2.6

Optional fields pertaining to the customer's billing address

Content of billingAddress

Field As of Version Comments
addressAdditional1 HP_ 2.0
addressAdditional2 HP_ 2.0
addressAdditional3 HP_ 2.0
city HP_ 2.0
company HP_ 2.0
country HP_ 2.0
postBox HP_ 2.0
state HP_ 2.0
street HP_ 2.0
streetNumber HP_ 2.0
zipCode HP_ 2.0
businessName HP_ 2.4

Content of billingContact

Field As of Version Comments
email HP_ 2.0
firstname HP_ 2.0
gender HP_ 2.0
lastname HP_ 2.0
mobile HP_ 2.0
phone HP_ 2.0
title HP_ 2.0
initials HP_ 2.2
legalId HP_ 2.4
positionOccupied HP_ 2.4

Optional fields pertaining to the customer's delivery address

Content of deliveryAddress

Field As of Version Comments
addressAdditional1 HP_ 2.0
addressAdditional2 HP_ 2.0
addressAdditional3 HP_ 2.0
city HP_ 2.0
company HP_ 2.0
country HP_ 2.0
postBox HP_ 2.0
state HP_ 2.0
street HP_ 2.0
streetNumber HP_ 2.0
zipCode HP_ 2.0
businessName HP_ 2.4

Content of deliveryContact

Field As of Version Comments
email HP_ 2.0
firstname HP_ 2.0
gender HP_ 2.0
lastname HP_ 2.0
mobile HP_ 2.0
phone HP_ 2.0
title HP_ 2.0
initials HP_ 2.2
legalId HP_ 2.4
positionOccupied HP_ 2.4

Optional fields pertaining to fraud

Content of fraudData

Field As of Version Comments
bypassCtrlList HP_ 2.0
bypassInfoList HP_ 2.0
bypass3DS HP_ 2.0
allowedCardCountryList HP_ 2.0
deniedCardCountryList HP_ 2.0
allowedIpCountryList HP_ 2.0
deniedIpCountryList HP_ 2.0
allowedCardArea HP_ 2.0
deniedCardArea HP_ 2.0
allowedIpArea HP_ 2.0
deniedIpArea HP_ 2.0
riskManagementDynamicSettingList HP_ 2.0 List of container riskManagementDynamicSetting . See the Containers part

Content of riskManagementDynamicSetting

Field As of Version Comments
riskManagementDynamicParam HP_ 2.0
riskManagementDynamicValue HP_ 2.0

Optional fields pertaining to cardholder data

Content of holderAddress

Field As of Version Comments
addressAdditional1 HP_ 2.0
addressAdditional2 HP_ 2.0
addressAdditional3 HP_ 2.0
city HP_ 2.0
company HP_ 2.0
country HP_ 2.0
postBox HP_ 2.0
state HP_ 2.0
street HP_ 2.0
streetNumber HP_ 2.0
zipCode HP_ 2.0
businessName HP_ 2.4

Content of holderContact

Field As of Version Comments
email HP_ 2.0
firstname HP_ 2.0
gender HP_ 2.0
lastname HP_ 2.0
mobile HP_ 2.0
phone HP_ 2.0
title HP_ 2.0
initials HP_ 2.2
legalId HP_ 2.4
positionOccupied HP_ 2.4

Content of holderData

Field As of Version Comments
birthCity HP_ 2.0
birthCountry HP_ 2.0
birthDate HP_ 2.0
birthZipCode HP_ 2.0
nationalityCountry HP_ 2.0
newPassword HP_ 2.0
password HP_ 2.0

Optional fields pertaining to means of payment

Content of paymentMeanData

Field As of Version Comments
sdd HP_ 2.4 See the Containers part

Content of sdd

Field As of Version Comments
mandateAuthentMethod HP_ 2.4
mandateCertificationType HP_ 2.4

Setting up the wallet management request

Here is an example of how to set up the wallet management request for each funtionality available in Sips Walletpage POST (the details of these functionalities are described in the Functionality set-up guide, OneClick payment and Subscription payment ).

Restriction of customer functionalities for wallet management

By default, the customer has access to all the wallet management functionalities. To restrict access, you must specify the list of desired functionalities in the WalletActionNameList field (as in the example below to only allow to add or modify payment methods in one's wallet):

      ..| |walletActionNameList=ADDPM,UPDATEPM |..
    

Dynamic restriction of means of payment

The means of payment that will be available for addition to the wallet must be filtered using the paymentMeanBrandList field:

      ..|paymentMeanBrandList=VISA,PAYPAL|..
    

Customer's wallet identification

The customer's wallet ID must be populated in the merchantWalletId field.

      …|merchantWalletId=1205987|..
    

Provider acting on behalf of a merchant

The provider's ID must be passed in the intermediateServiceProvider field of the request, and the provider's secret key must be used to calculate the Seal field:

      ..|intermediateServiceProviderId=241591|..
    

Response processing

There are two types of responses. Although the protocol, format and content of both responses are identical, the latter must be managed differently because they meet different needs.

Responses are HTTP(S) POST responses sent to the normalReturnUrl (mandatory) and automaticResponseUrl (optional) URLs specified in the request.

You must set up the system that will decode these responses so you can know the result of the request.

The following four data are defined in the responses:

Field name Comments/rules
Data Fields concatenation in the response.
Encode Type of encoding used to encode the Data field. This field is populated using the responseEncoding field from the request.
Seal Response message signature.
InterfaceVersion Connector interface version.

If the value of the Encode field is “base64” or “base64url”, the Data field must be encoded using Base64/Base64Url so the concatenated string of fields is reconstructed. The concatenated string is structured as follows: key1=value1|key2=value2, etc. The seal ( Seal field) of both responses is hashed with the same algorithm as the one supplied as input in the sealAlgorithm field. If no value was defined, SHA-256 is used by default.

Note: for a seal to be computed with the HMAC-SHA-256 algorithm, the input parameters of the request must include the sealAlgorithm field populated with the following value: “HMAC-SHA-256”.

The value of the Seal field is computed as follows:

For the HMAC-SHA algorithm:

  • use of the shared secret key to generate the HMAC variant of the message
  • use of the Data field only (encoded if the corresponding option is selected)
  • UTF-8 encoding of the data constituting the result of the previous operation
  • HMAC-SHA hashing of the bytes obtained

This procedure can be summarised as follows:

      HMAC-SHA256( UTF-8(Data), UTF-8(secretKey))
    

For the SHA-256 algorithm (although this is the default value, this algorithm is no longer recommended):

  • concatenation of the Data field and of the secret key (encoded if the corresponding option is selected)
  • UTF-8 encoding of the data constituting the result of the previous operation
  • SHA256 hashing of the bytes obtained

This procedure can be summarised as follows:

      SHA256( UTF-8(Data+secretKey ) )
    

Specifying the manual response URL

The main goal of the manual response is to redirect the customer to your website and specify the wallet management result.

The main WL Sips page includes the "Back" button with a link that redirects the customer to your website. Clicking on this button, the customer is redirected by WL Sips to the URL address included in the normalReturnUrl field provided in the request. The redirection is a HTTP(S) POST request that contains the data of the response. It is your responsibility to retrieve those paramaters and check the signature, thus ensuring the integrity of the response. Besides, you are in charge of displaying relevant messages to your customer (i.e. messages pertaining to the details of the response).

This normalReturnUrl field is also used for all payment results (cancellation, refusal, etc.) so as to perform the redirection to your site.

It is important to note that the receipt of the response cannot be guaranteed, since this response is sent by the customer’s Web browser. First, the customer may choose not to click on the link. Then he might encounter connection issues that block the transmission of this response. Therefore, your business processes cannot be based only on this response.

Note: the current version of InterfaceVersion is  HP_ 2.6 . Please refer to the WL Sips data dictionary for a comprehensive description of parameters included in the response.

Specifying the automatic response URL

The automatic response is sent only if the automaticResponseUrl field was sent in the wallet management request. If that is the case, the WL Sips server sends a HTTP(S) POST response to the URL address received.

The fields of the automatic response are the same as those of the manual response. The only difference between both procedures is that the automatic response is sent directly by the WL Sips server and does not go through the customer's Web browser. Therefore, this response is much more reliable since it is always sent. The WL Sips server does not expect any response after the automatic response has been sent.

It is your responsibility to retrieve the various data of the response, check the signature to make sure the fields of the response have not been tampered with, and update your back office.

Note: the current version of InterfaceVersion is HP_ 2.33 . Please refer to the Data dictionary for a comprehensive description of the settings included in the response.

Solving response receipt issues

Below is a list of the most common issues that block the receipt of automatic and manual responses. Please make sure you have checked them before you call the technical support:

  • Make sure the response URLs are provided in the wallet management request and are valid. To do this, simply copy and paste them into the address bar of your browser.
  • The supplied URLs must be accessible from the outside, i.e. the Internet. Access control mechanisms (login/password or IP address filter) or a firewall might block access to your server.
  • Access to response URLs must be confirmed in the notifications report of your web browser.
  • If you use a non-standard port, it must be within the 80 to 9999 range to ensure compatibility with WL Sips .

In some error cases, the WL Sips Server is unable to sign the response message. This applies, for instance, to the "Unknown merchantID" error and to the situation where the secret key is unkwown to WL Sips . For these particular reasons, the payment server will send a response without a signature in the Seal field.

Retrieving response fields

The content of Sips Walletpage 's automatic and manual web responses is identical.

Field name Version Comments
merchantId HP_ 2.0
keyVersion HP_ 2.0
merchantWalletId HP_ 2.0
merchantSessionId HP_ 2.0
customerId HP_ 2.0
customerIpAddress HP_ 2.0
returnContext HP_ 2.0
walletCreationDateTime HP_ 2.0
walletLastActionDateTime HP_ 2.0
walletPaymentMeanDataList HP_ 2.0 List of wallet payment means (see table below: fields in the walletPaymentMeanData element).
customerCompanyName HP_ 2.4
customerBusinessName HP_ 2.4
customerLegalId HP_ 2.4
customerPositionOccupied HP_ 2.4
Field name Version Comments
paymentMeanId HP_ 2.0
paymentMeanAlias HP_ 2.0
paymentMeanBrand HP_ 2.0
maskedPan HP_ 2.0
panExpiryDate HP_ 2.0
mandateId HP_ 2.4
transactionActors HP_ 2.4
Note: manual and automatic responses are encoded in base64 or in base64url.

Analysing the response to the wallet management request

If you carry out the authentication steps by means of an electronic seal, you should make sure the seal you received actually matches the seal you recomputed using the response fields.

In case the seal you received does not match the seal you recomputed, the wallet management session status is considered unknown, please contact the support.

Status Response fields Action to perform
Wallet management operation taken into account

walletLastActionDateTime populated with the current date and time

walletPaymentMeanDataList contains the means of payment in the wallet after the update

Store the following wallet data in your customer database:

  • paymentMeanAlias
  • paymentMeanId
  • paymentMeanBrand
  • PanExpiryDate
  • maskedPAN
Wallet management operation not taken into account

walletLastActionDateTime not populated with the current date and time

walletPaymentMeanDataList contains the means of payment in the wallet

If the wallet must be updated, then submit a request again.

Step 3: testing in the simulation environment

Once you have developed the connection to Sips Walletpage , you can do a test on the Sips Walletpage simulation server.

URL de simu du serveur https://payment-webinit.simu.sips-services.com/walletManagementInit

To do the test, use the id depending on the identification mode you wish to use:

Table 1. transactionReference generated by the merchant
Field Value
Merchant ID (merchantId) 002001000000001
Key Version (keyVersion) 1
Secret key 002001000000001_KEY1
Table 2. transactionReference generated by WL Sips
Field Value
Merchant ID (merchantId) 002001000000002
Key Version (keyVersion) 1
Secret key 002001000000002_KEY1
Table 3. transactionId generated by the merchant
Field Value
Merchant ID (merchantId) 002001000000003
Key Version (keyVersion) 1
Secret key 002001000000003_KEY1
Table 4. transactionId generated by WL Sips
Field Value
Merchant ID (merchantId) 002001000000004
Key Version (keyVersion) 1
Secret key 002001000000004_KEY1
Note: in the simulation environment, all operations are simulated. There is no interaction with the wallet database when adding or deleting means of payment.

Testing the addition of cards into the wallet

If you want to save a card, you will be redirected to the card details entry page where you will enter the detailed information of your card.

The following simulation rules apply:

  • The PAN must be 15 to 19 digits long (depending on the means of payment used).
  • The first six digits of the PAN determine the type of card as per the table below.
Card type Card number beginning with
AMEX 340000
VPAY 400000
VISA 410000
CB 420000
CB-VISA co-branded cards 430000
CB-VPAY co-branded cards 440000
CB-VISA_ELECTRON co-branded cards 450000
VISA-MASTERCARD co-branded cards 460000
MASTERCARD 510000
MAESTRO 500000
CB-MASTERCARD co-branded cards 520000
CB-MAESTRO co-branded cards 530000
  • you can simulate the successful or failed addition of a card by choosing from all response codes (see the Data Dictionary) and changing the last two digits. Only the answer code '00' simulates a successful addition.

Example : if you use card number 4100 00 00 0000 00 05 , the card is identified as VISA and the addition is not made (response code WL Sips 0 5 ).

Note: co-branded cards can be used with each of the brands specified in the table.

Moreover, all cards are enrolled in the 3-D Secure programme. You are redirected to the 3-D Secure simulation server where you choose the desired result for 3-D authentication.

Step 4: validating the switch to the production environment

Once you have tested your website connection to Sips Walletpage POST , you can validate the connection to the production version of Sips Walletpage POST .

Prior to this, we recommend you block public access to your website to prevent customers from carrying out transactions during this validation phase.

If you would like to customise your payment pages, you can use our CustomPages tool to test and view the rendering on payment pages. To do so, please refer to the CustomPages documentation to use the tool.

To switch to the production server, you must change the URL in order to connect to the WL Sips production server using the merchantId , secretKey and keyVersion credentials you received during the registration phase.

WL Sips URL https://payment-webinit.sips-services.com/walletManagementInit
merchantId Shop identifier received by e-mail
SecretKey Secret key you can retrieve from the Sips Download extranet
keyVersion Secret key version retrieved from Sips Download (obviously 1 for the first key)
Note: forgetting one of these 4 parameters is a common mistake that systematically results in an error.

How to validate proper functioning in the production environment

  • Initiate a wallet by adding a first card into it.
  • Make sure the wallet has been created.
  • Add a second card into an existing wallet if you have subscribed to the multi-card option.
  • Make sure the second card has been added.

Step 5: launching live operation

Once the validation for the transition to live operation has been carried out, make your site public so your customers can add means of payment to their wallets.