Release 22.5

go directly to content

Search by keywords

Sips Paypage JSON

To search in the page use Ctrl+F on your keyboard

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 upon shipping, deferred payment, recurring payment, payment in instalments, etc.).

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

This document is intended for merchants wishing to subscribe to the WL Sips offer and use a connector based on HTTPS exchanges in JSON mode between their websites and the Sips Paypage JSON payment servers.

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

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

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.

Upon your subscription, Worldline provides a secret key on the Merchant 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 Merchant Extranet.

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).

The general principle for a payment process is as follows:

picture of the general principle of a payment scheme

1. When the customer makes a payment, a payment request must be sent to Sips Paypage JSON. The URL of this connector is provided by Worldline. The request is then checked, and encryted if valid (it is named RedirectionData in the system). The request is sent through a POST form via HTTPS. Any other solution that can send such requests also works.

2. The merchant site redirects the calling application to the WL Sips payment pages. The customer must enter the information of the means of payment for the WL Sips payment server to process the transaction. It is worth noting that payment details can be entered directly on the server that provides the means of payment (e.g. PayPal or SEPA mandate). At the end of the payment process, whether successful or not, two responses are created and sent to the URL specified as part of flow No. 1.

There are two independent response notifications:

3. The payment server sends the manual responses in HTTP(S) POST format to the manual response URL. This URL is specified in the payment request and is used when the customer clicks on the Continue button of the payment page. It is the page the user is redirected to at the end of the payment. As nothing guarantees that the customer will click on this link, you have no guarantee of receiving the manual response either.

4. Automatic responses are sent separately from manual responses. They also use the HTTP(S) POST requests sent by the WL Sips payment servers, this time using the automatic response URL specified in the payment request. This means you receive the response as soon as the payment is made on the WL Sips payment pages.

IMPORTANT: if you do not have the "New payment attempt" option (see "New payment attempt" section in the document "Functionality set-up guide"), if the payment has failed and the customer is redirected to your website, it is no longer possible to return to the WL Sips payment pages and attempt to pay again or correct card data. The role of your website is to initialise a new payment request, beginning with calling the Sips Paypage connector.

In order to register your shop as live, you are required to complete the registration form sent by Worldline and send the form back to the latter.

When filling in the form, you must appoint an administrator contact and a technician contact so that Worldline can send you the information needed to launch your shop.

Worldline will then register your shop and e-mail you your merchant ID, together with your IDs and passwords for Merchant Extranet (to retrieve the secret key and perform cash management).

Note: For Merchant Extranet, the connexion information are sent to the administrator contact.

Registering the shop is not needed to start integrating the connector and testing the connection on the customer test environment. It is possible to defer requesting shop registration until you perform live operation tests.

The payment request is a call to a REST web service (JSON) located on the WL Sips payment platform.

Attention: please remember you need to indicate in your message header that the data to be processed is of JSON type. To do this, you need to specify the 'Content-Type: application/json' header in your JSON message. Otherwise you might receive an error message similar to the following:
        <title>415 Unsupported Media Type</title>
        <h1>Unsupported Media Type</h1>
        <p>The supplied request data is not in a format
acceptable for processing by this resource.</p>
Tip: you can consult the examples published on our GitHub repository to help you make a payment request.

All the fields requested by the transaction must be supplied (please refer to the "Filling in the request fields" chapter).

The value of the interfaceVersion field must be set to IR_WS_2.44.

The request is structured in line with the JSON format:

{“<field name>” : ”<value name>”, “<field name>” : “<value name>”, “field name” : “value name” etc., “seal” : seal value” }

Sample payment request with an amount of 10 euros:

{"amount" : "1000","automaticResponseUrl" : "https://responseurl.com","currencyCode" : "978","interfaceVersion" : "IR_WS_2.19","keyVersion" : "1","merchantId" : "000000000000012","normalReturnUrl" : "https://responseurl2.com","orderChannel" : "INTERNET","transactionReference" : "1232015021717313","seal" : "858005903b91ae3b3a076e29aca7dc6314c05aa6f929c439ecfce1de17ea7e39"}

The syntax used to create a JSON list complies with the standard. Here is a summary of this structure for the two main list types: simple field lists (e.g. character strings) and object lists.

A field can have several values:

…,"field name" : ["value1","value2"],…

Sample paymentMeanBrandList field with VISA and MASTERCARD as values:

…,"paymentMeanBrandList" : ["VISA","MASTERCARD"],…

If a field contains a list of complex objects, its representation is structured using the following format:

…,“field name” : [{“name of subfield1”:”value1”,“name of subfield2”:”value2”},{“name of subfield1”:”value3”, name of subfield2”:”value4”}],…

Sample payment request with a list of complex objects for the shoppingCartDetail field, containing two products, apple and mango:

{"amount" : "1000","automaticResponseUrl" : "https://responseurl.com","currencyCode" : "978","interfaceVersion" : "IR_WS_2.8","keyVersion" : "1","merchantId" : "000000000000012","normalReturnUrl" : "https://responseurl2.com","orderChannel" : "INTERNET","shoppingCartDetail" : {"shoppingCartItemList" : [{"productCode" : "123","productName" : "apple"},{"productCode" : "456","productName" : "mango"}],"shoppingCartTotalAmount" : "1000"},"transactionReference" : "1232015021717313","seal" : "fac5bc8e5396d77a8b31a2a79a38750feea71b22106a2cec88efa3641a947345"}

Some fields of the payment request are required:

  • Only when using certain means of payment. Please read the dedicated means of payment guide to know the mandatory fields.
  • Depending on your shop configuration. Please read the Functionality set-up guide to find out the mandatory fields.
  • Only in certain use cases (e.g. recurring payment). Please read the Functionality set-up guide to know the mandatory fields.

Those fields are marked as "conditional".

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.

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.

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

  • Concatenation of data field values in the alphabetical order of field names (in accordance with ASCII character codes), without integrating the keyVersion and sealAlgorithm fields. Giving the field data, mentioned in the examples below.
    • as an example, a field that would be named authorMessageReference must be positioned before another field named authorisationId
  • Obtaining the UTF-8 encoding of the 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(sortedDataValues), UTF-8(secretKey))
Attention: by default, the seal is computed with the HMAC-SHA-256 algorithm, the use of which we strongly recommend.

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

  • Sample Hmac Sha256 encoding in Php 5
    // 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");
      return encodeHexString(hmacSHA256.doFinal(data.getBytes()));
     * @param args
    public static void main(String[] args) {
    try {
    System.out.println (computeSeal("parameters", "key"));
    } catch (Exception e) {
  • 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()
            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); 
                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();

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

  "amount": "2500",
  "automaticResponseUrl": "https://automatic-response-url.fr/",
  "normalReturnUrl": "https://normal-return-url/",
  "captureDay": "0",
  "captureMode": "AUTHOR_CAPTURE",
  "currencyCode": "978",
  "interfaceVersion": "IR_WS_2.22",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "orderChannel": "INTERNET",
  "orderId": "ORD101",
  "returnContext": "ReturnContext",
  "transactionOrigin": "SO_WEBAPPLI",
  "transactionReference": "TREFEXA2012",
  "seal": "322b943d833417c1570e0a282641e8e29d6a5b968c9b846694b5610e18ab5b81"

For the above request, the concatenated string which must be calculated is:


With a HMAC-SHA-256 hash algorithm and the following secret key:


The expected seal is:


In return to this request, you should receive a response (also in JSON) containing the following fields:

Field name Description
redirectionData Request token to be provided during the redirection to the payment pages.
redirectionStatusCode List of possible response codes.
redirectionStatusMessage Short message providing the initialisation status.
redirectionUrl URL of the WL Sips payment pages you have to redirect the customer to.
redirectionVersion Redirection version.
seal Output seal.
reponseEncoding Encoding type used for responses.

If the payment initialisation was successful, the redirectionStatusCode field must be populated with "00". The redirectionData, redirectionVersion and redirectionUrl fields will likewise be populated to allow the redirection to the WL Sips payment pages.

To redirect the customer to the payment pages, you must implement a POST form sending the two following fields: redirectionData and redirectionVersion. The POST form shall redirect the customer to the URL provided in the redirectionUrl field.

Below is a sample form that must be submitted automatically:

<form method="post" action=”value of redirectionURL”>
    <input type="hidden" name="redirectionVersion" value=”value of redirectionVersion”>
    <input type="hidden" name="redirectionData" value=”value of redirectionData”>

All fields received by Sips Paypage JSON 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.

redirectionStatusCode Description
00 Standard situation followed by the standard process used to display the payment pages.
03 The merchantId or the acquirer contract is not correct.
12 The transaction parameters are not correct. Please check the request parameters.
30 The request format is not correct.
34 Security issue: e.g. the computed seal is not correct.
94 The transaction already exists.
99 Service temporarily unavailable.

There are four possible situations:

  • RedirectionStatusCode = 00

The user must be redirected to the payment page.

  • RedirectionStatusCode = 03, 12, 30, 34

These error codes indicate that the request has an issue that needs to be fixed. The payment process must be stopped.

  • RedirectionStatusCode = 94

The transaction reference has already been used. You need to try again with another transaction reference.

  • RedirectionStatusCode = 99

The payment service is unavailable. Try to submit the request again. A new transaction reference must be used to prevent response code 94 from being returned.

The request and the response of paymentWebInit method are described in this page.

Here is an example of how to set up the payment request for each functionality available in Sips Paypage JSON (the details of these functionalities are described in the Functionality set-up guide).

You need to use the paymentMeanBrandList field to filter the means of payment that will be displayed on the means of payment selection page:

.. ,"paymentMeanBrandList":["VISA","PAYPAL"],..

The payment confirmation page that WL Sips displays by default can be deactivated using the paypageData.bypassReceiptPage field:


To choose your payment channel, you must fill in the orderChannel field in the payment request:


For end-of-day payments, simply fill in the captureMode and captureDay fields:


For payments that must be captured N days after they were accepted online, simply fill in the captureMode and captureDay fields (3 days in the following example):


For more complex cases of deferred payments, such as multiple shipments or shipment beyond 6 days, please refer to the "multiple payment on dispatch" guide.

For payments upon shipping, the transaction is captured during your validation. You just need to fill in the captureMode and captureDay fields (in the following example, a period of up to 3 days before the validation is set):


For payments with instalments linked to a very same transaction, you need to populate the paymentPattern field with the INSTALMENT value and provide details about instalments in the instalmentData field (in the following example, €600 paid in 3 instalments) :


For immediate payment (available with certain means of payment only), the transaction is paid for during the online authorisation:


For multicurrency transactions, the currency code must be specified in the request. The payment currency is specified in the acquiring contract.


Acceptance and payment are carried out in the same currency, which must be specified in the request. Payment in foreign currencies is an option of the acquiring contract.


If a Dynamic Currency Conversion (DCC) service is used, the reference currency code must be specified:


For OneClick payments, the customer's wallet ID must be provided in the merchantWalletId field.


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:


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.

IMPORTANT: 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 ) )

The main goal of the manual response is to redirect the customer to your website with the result of the payment so you can make the right decision about it. For instance, if an error occurred, you may suggest to the customer to attempt the payment again. If the payment is successful, you can display a “thank you” message and start despatching the goods.

During the final step, a 'Continue' button is displayed on the WL Sips payment page, with a link that redirects the user to your site. When the customer clicks on this link, the WL Sips server redirects them to the URL contained in the normalReturnUrl field supplied in the request. The redirection is a HTTP(s) POST request that contains the data of the response as described above. It is your responsibility to retrieve these parameters 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.

Tip: the current version of InterfaceVersion is HP_2.44. Please refer to the Data dictionary for a comprehensive description of parameters included in the response.

The automatic response is sent only if the automaticResponseUrl field was sent in the payment 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.

Tip: the current version of InterfaceVersion is HP_2.44. Please refer to the Data dictionary for a comprehensive description of the settings included in the response.
Attention: the automatic response is systematic, asynchronous and sent back through the network; it is inherently dependent on potential technical troubles on the various network elements and can now and then be received with a more or less substantial delay, or even never be received at all.

The automatic response is sent at the end of the payment. However, if your customer drops their purchase, for example by exiting their browser, the automatic response is sent when the user session expires (after 15 minutes of inactivity). Therefore, if your customer drops their purchase, you will only receive the automatic response (not the manual response), with an answer code set at 97, about 15 to 16 minutes after the customer has been redirected to the payment pages.

If an automatic response is not received after approximately 16 minutes, you can get the result of a payment by calling the getTransactionData method of the Sips Office interface, or by analysing the contents of the Transactions report. You may also search for a transaction and see its status using Sips Office Extranet.

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 payment 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.
  • Context parameters cannot be added to the response URLs. However, some fields can still be used, e.g. the orderID or returnContext fields make it possible to provide extra parameters. You may also use the sessionId field to retrieve information about your customer at the end of the payment process.

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.

The content of the automatic and manual responses sent by Sips Paypage is identical. This content may vary according to the payment result (successful or other).

Note: in the responses, depending on the transaction status and the payment mean chosen, some fields can be null, empty or not returned. Please refer to the payment means documentations to know the fields present in the responses.
Field Version Comments
acceptanceSystemApplicationId HP_2.39
acquirerContractNumber HP_2.25
acquirerNativeResponseCode HP_2.12
acquirerResponseCode HP_2.0
acquirerResponseIdentifier HP_2.8
acquirerResponseMessage HP_2.8
additionalAuthorisationNumber HP_2.8
amount HP_1.0 Same as in the request
authentExemptionReasonList HP_2.28
authorisationId HP_1.0
authorisationTypeLabel HP_2.39
authorMessageReference HP_2.39
avsAddressResponseCode HP_2.17
avsPostcodeResponseCode HP_2.17
captureDay HP_1.0 Request field that WL Sips may override.
captureLimitDate HP_2.3
captureMode HP_1.0 Request field that WL Sips may override.
cardCSCResultCode HP_2.0
cardProductCode HP_2.12
cardProductName HP_2.12
cardProductProfile HP_2.12
cardProductUsageLabel HP_2.39
challengeMode3DS HP_2.41 Request field that WL Sips may override.
complementaryCode HP_1.0
complementaryInfo HP_2.0
creditorId HP_2.7
currencyCode HP_1.0 Same as in the request
customerBusinessName HP_2.17
customerCompanyName HP_2.17
customerEmail HP_2.0 Same as in the request
customerId HP_2.0 Same as in the request
customerIpAddress HP_2.0 Same as in the request, or recomputed by Sips Paypage if missing
customerLegalId HP_2.17
customerMobilePhone HP_2.1 Same as in the request
customerPositionOccupied HP_2.17
dccAmount HP_2.3
dccCurrencyCode HP_2.3
dccExchangeRate HP_2.3
dccExchangeRateValidity HP_2.3
dccProvider HP_2.3
dccStatus HP_2.3
dccResponseCode HP_2.3
dueDate HP_2.3
guaranteeIndicator HP_2.0
hashPan1 HP_2.0
hashPan2 HP_2.0
holderAuthentMethod HP_2.4
holderAuthentProgram HP_2.5
holderAuthentRelegation HP_2.0
holderContactEmail HP_2.20
holderAuthentStatus HP_2.0
holderAuthentType HP_2.24
instalmentAmountsList HP_2.6
instalmentDatesList HP_2.6
instalmentNumber* HP_2.6
instalmentTransactionReferencesList HP_2.6
interfaceVersion HP_1.0
intermediateServiceProviderOperationId HP_2.23
invoiceReference HP_2.10
issuerCode HP_2.12
issuerCountryCode HP_2.12
issuerEnrollementIndicator HP_2.0
issuerWalletInformation HP_2.9
issuingCountryCode HP_2.44
keyVersion HP_1.0 Same as in the request
mandateAuthentMethod HP_2.2
mandateCertificationType HP_2.7
mandateId HP_2.3
mandateUsage HP_2.2
maskedPan HP_1.0
merchantId HP_1.0 Same as in the request
merchantSessionId HP_2.0 Same as in the request
merchantTransactionDateTime HP_2.0 Same as in the request
merchantWalletId HP_2.0 Same as in the request
orderChannel HP_2.0 Same as in the request
orderId HP_1.0 Same as in the request
panEntryMode HP_2.4
panExpiryDate HP_2.0
paymentAccountReference HP_2.28
paymentAttemptNumber HP_2.18
paymentMeanBrand HP_1.0
paymentMeanBrandSelectionStatus HP_2.14
paymentMeanData HP_2.2
paymentMeanId HP_2.6
paymentMeanTradingName HP_2.8
paymentMeanType HP_1.0
paymentPattern HP_2.0 Same as in the request
preAuthenticationColor HP_2.10
preAuthenticationInfo HP_2.10
preAuthenticationProfile HP_2.10
preAuthenticationProfileValue HP_2.14
preAuthenticationRuleResultList HP_2.14 List of preAuthenticationRuleResult objects.
Please see below for its content and format.
preAuthenticationThreshold HP_2.10
preAuthenticationValue HP_2.10
preAuthorisationProfile HP_2.14
preAuthorisationProfileValue HP_2.14
preAuthorisationRuleResultList HP_2.14 List of preAuthenticationRuleResult objects.
Please see below for its content and format.
responseCode HP_1.0
returnContext HP_1.0 Same as in the request.
s10TransactionId HP_2.9
s10TransactionIdDate HP_2.9
s10transactionIdsList HP_2.11
schemeTransactionIdentifier HP_2.28
scoreColor HP_2.0
scoreInfo HP_2.0
scoreProfile HP_2.0
scoreThreshold HP_2.0
scoreValue HP_2.0
secureReference HP_2.26
settlementMode HP_2.7
settlementModeComplement HP_2.13
statementReference HP_2.4
tokenPan HP_2.0
transactionActors HP_2.2 Same as in the request.
transactionDateTime HP_1.0
transactionOrigin HP_2.0 Same as in the request.
transactionPlatform HP_2.16 For future use (for now, its value is systematically set to ‘PROD’).
transactionReference HP_1.0
virtualCardIndicator HP_2.36
walletType HP_2.4
  • Content of preAuthenticationRuleResult
Field Version Comments
ruleCode HP_2.14
ruleType HP_2.14
ruleWeight HP_2.14
ruleSetting HP_2.14
ruleResultIndicator HP_2.14
ruleDetailedInfo HP_2.14
  • Content of preAuthorisationRuleResult
Field Version Comments
ruleCode HP_2.14
ruleType HP_2.14
ruleWeight HP_2.14
ruleSetting HP_2.14
ruleResultIndicator HP_2.14
ruleDetailedInfo HP_2.14

The format of a list of complex objects in automatic and manual responses is defined as follows (bold text):

  • The content of the list is in square brackets [ ].
  • Each entry of the list is in curly brackets { }.
  • Each field is represented as "fieldName" = "fieldValue".
  • Please note that the name and the value of the field are both in double quotes "".
  • Pairs of adjacent names/values are separated by a comma.

Sample preAuthorisationRuleResultList field

Breakdown of the fraud rules executed during preauthorisation (bold text):


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 transaction status is considered unknown, please leave the transaction as it is, contact the support and do not re-execute the transaction in any automated way.

Status Response fields Actions to be carried out

Payment accepted

responseCode = 00

acquirerResponseCode = 00

garanteeIndicator = Y,N,U, empty

You can deliver the order according to the guarantee level of your choosing (garanteeIndicator field).

WL Sips fraud refusal


responseCode = 05

complementaryCode = XX


The payment has been refused by the WL Sips fraud engine that you configured.

Do not deliver the goods.

Analyse in detail the fraud rules executed by WL Sips to know the reason for the refusal (preAuthorisationRuleResultList field).

WL Sips fraud refusal

Business Score

responseCode = 05

scoreColor = RED, BLACK

scoreValue = X (transaction score)

scoreThreshold = X,Y (orange threshold, green threshold)

The payment has been refused by the WL Sips fraud engine that you configured.

Do not deliver the goods.

Analyse in detail the fraud rules executed by WL Sips to know the reason for the refusal (preAuthorisationRuleResultList field).

WL Sips fraud warning

Business Score

responseCode = 05

scoreColor = ORANGE

scoreValue = X (transaction score)

scoreThreshold = X,Y (orange threshold, green threshold)

The acquirer has authorised the payment, but the WL Sips fraud engine issued a warning due to the rules you configured.

Analyse in detail the fraud rules executed by WL Sips to know the reason for the warning (preAuthorisationRuleResultList field).

If the transaction poses no risk, accept it using the acceptChallenge function.

If the transaction poses a risk, refuse it using the refuseChallenge function.

The acceptChallenge and refuseChallenge functions are available on the extranet and the Sips Office connectors.

3-D Secure refusal

reponseCode = 05

holderAuthenStatus = FAILURE

Customer authentication failed. This is not necessarily due to fraud. You can suggest to your customer to attempt the payment again with another means of payment, by generating a new request.

Banking refusal from the acquirer

responseCode = 05

acquirerResponseCode = XX

Authorisation refused for a reason not related to fraud.

You can suggest to your customer to attempt the payment again with another means of payment, by generating a new request.

Soft decline

responseCode = 05

acquirerResponseCode = A1

The payment has been refused by the acquirer because the 3-D Secure data is missing in the authorisation request.
Please try to pay again with a 3-D Secure payment process.

Fraud refusal from the acquirer

responseCode = 34

acquirerResponseCode = XX

Authorisation refused because of fraud.

Do not deliver the order.

Refusal because the maximum number of attempts has been reached

responseCode = 75

acquirerResponseCode = XX

The customer made several failed attempts because the information entered was incorrect. There are two possibilities:

  • Your customer has difficulties entering their card information.
  • Carding attempt (search for possible card numbers).

Please contact your customer to define what to do next.

Refusal due to a technical issue

responseCode = 90, 99

acquirerResponseCode = 90 to 98

Temporary technical issue while processing the transaction.

Please tell your customer to attempt the payment again later.

Abandonment of payment responseCode = 97

acquirerResponseCode = not filled

Do not deliver the order.

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

To do this test, you must use the credentials according to the transaction identification mode you wish to use:

Simulation server URL https://payment-webinit.simu.sips-services.com/rs-services/v2/paymentInit/
Table 1. transactionReference generated by the merchant
Field Value
Merchant ID (merchantId) 002001000000001
Secret key (secretKey) 002001000000001_KEY1
Key version (keyVersion) 1
Table 2. transactionReference generated by WL Sips
Field Value
Merchant ID (merchantId) 002001000000002
Secret key (secretKey) 002001000000002_KEY1
Key version (keyVersion) 1
Table 3. transactionId generated by the merchant
Field Value
Merchant ID (merchantId) 002001000000003
Secret key (secretKey) 002001000000003_KEY1
Key version (keyVersion) 1
Table 4. transactionId generated by WL Sips
Field Value
Merchant ID (merchantId) 002001000000004
Secret key (secretKey) 002001000000004_KEY1
Key version (keyVersion) 1

This simulation server is not connected to the actual banking servers, because it serves to validate the connection between your website and the payment server.

Therefore, Sips Paypage simulates the call to the authorisation servers so you can test the various results of a payment.

Consequently, using actual cards is not necessary for tests.

Attention: since the merchantId is shared by all merchants and prospects, there might be transactionReference duplicates. This is why it is highly recommended to prefix all transactionReferences with the name of the future shop that will be used in the production environment. This also makes support easier if you call the technical support.

You use a generic shop without any payment page customisation. Step 4 will enable you to customise your payment pages.

The following simulation rules apply:

  • The PAN (Primary Account Number) must consist of 15 to 19 digits (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 begins 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
    MAESTRO 500000
    MASTERCARD 510000
    CB-MASTERCARD co-branded cards 520000
    CB-MAESTRO co-branded cards 530000
  • The WL Sips response code (responseCode field) is computed from the last two digits of the card number.
  • The security code (CVV) consists of 3 or 4 digits. This value does not matter when it comes to the result of the simulation.

Example: if you use the card number 4100 0000 0000 0005, the card will be identified as a VISA card and the payment will be refused (WL Sips response code 05).

Note: if the computed WL Sips response code is not referenced, the transaction is accepted (respondeCode = 00).

Co-branded cards can be used with every brand defined in the table.

All cards are enrolled in the 3-D Secure programme. You will be redirected to the 3-D Secure simulation server on which you will choose the desired 3-D Secure authentication result.

If you choose to test iDeal, you will be redirected to the simulation server that simulates iDeal transactions according to their amounts. You will then be taken back to the payment server that will display the receipt showing the transaction result.

Rules for simulating iDeal payments:

Transaction amount iDeal response
EUR2.00 Transaction cancelled
EUR3.00 Transaction expired
EUR4.00 Transaction not carried out
EUR5.00 Transaction failed
Other cases Transaction OK

If you choose to test PayPal, you will be redirected to the simulation server that simulates PayPal transactions according to their payment result on PayPal’s side. You will then be taken back to the payment server that will display the receipt showing the result of the payment.

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

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/rs-services/v2/paymentInit
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)
Attention: forgetting one of these 4 parameters is a common mistake that systematically results in an error.


  • Make a transaction using a real payment card (your own, if possible). If the transaction is accepted, it will be sent to the bank to credit your merchant account and to debit the card account.
  • Check that your payment pages include your customisation settings.
  • Check the transaction via Sips Office Extranet, using the transactionReference.

The next day:

  • Make sure the transaction is in the Transactions report.
  • Check your account to make sure the operation was credited.
  • Refund the transaction via Sips Office Extranet (optional).

Two days later:

  • Check that the refund transaction is in the Operations report.
  • Make sure the debited amount has been refunded to your merchant account.

This validation process is also applicable to the PayPal means of payment.

Once the validation for the transition to live operation has been carried out, make your site and/or application public so your customers can make purchases and payments.

On the same day:

  • Monitor acceptance rates (number of responseCode 00 per total number of transactions)
  • Check the nature of non-banking declines:
    • technical issue: responseCode 90, 99
    • fraud: responseCode 34
    • maximum number of payment attempts reached: responseCode 75
    • abandonment: responseCode 97

The next day:

  • Check that all transactions processed (accepted and refused) are in the Transactions report.
  • Check the operations you have carried out and remittances (report option) in the Operations report.

This site uses trackers to improve your experience, perform analysis and researches on your use of WL Sips documentation website.
You have several options:
Closing this banner you refuse the use of trackers on your device.