WL SIPS DOCS

Release 22.3

go directly to content

Search by keywords

Subscription payment via duplication

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

It is advised to read the following documents before

  • Recommended

    MIT/CIT chaining

    Functional, technical documentation and user guides to help you to integrate WL Sips online payment solution.

    Open in new tab MIT/CIT chaining

WL Sips is a secure, multichannel 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 of the subscription-based payment solution up to the start of production.

This document is intended to help you implement the recurring payments for the services they provide to their customers (hereinafter referred to as subscribers).

The purpose is to present the features of subscription payments and explain how to implement them with the WL Sips solution.

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

  • Functional presentation
  • Functionality set-up guide
Note: WL Sips does not manage the subscribers personal details (first name, surname, address, age, email, telephone, etc.), just the payment details that let you debit or credit your subscribers.

Subscription payments require your subscribers' payment details to be stored by WL Sips to ensure that you can make payments.

Therefore, here are some points to address before you can get started:

  • To comply with the GDPR, you must complete your internal personal data processing register, specifying that the card details are stored in WL Sips platform. For more information on the GDPR, please refer to our Sips information systems security.
  • Inform your customers that their recurring payment details and methods will be stored (duration, amount, frequency etc.).
  • Check with your acquirer that your contract supports recurring payments.

Subscription payment has several parts:

  • subscriber enrolment and authentication (CIT);
  • debits for the occurrences of the subscription (MIT) by duplicating the CIT ;
  • managing the subscriber's means of payment expiry

The means of payment for recurring payments are :

  • CB, Visa, Mastercard, Amex, Bancontact (WIP option required)
  • SEPA Direct Debit (SDD) Mandate

When enrolling the subscriber (CIT), please keep the following information:

You can then debit your subscriber on a recurring basis, by file transfer or online.

Because WL Sips offers several interfaces to deal with subscription taking out and with recurring payments, you have to analyse your business need so as to choose the connectors best suited to your situation.

The table below helps you make your choice.

Use case Sips Paypage Sips Office Sips Office CSE Sips In-App Sips Office Batch Sips Office Extranet Back Office Choice of connector
Subscription taking out
You want to get free from PCI requirements. V X V V X X If you use Sips Paypage to process your payments, you can capitalise on this existing integration to handle the subscription taking out. For m-commerce, we recommend the use of Sips In-App.
You display and secure the pages for entering payment details X V V V X X Sips Office meets your need for e-commerce. For m-commerce, we recommend the use of Sips In-App.
Recurring payments
You debit or credit your subscribers at due dates (in the case of packages or services billed after consumption). X V X X V V Sips Office Batch file mode is the connector suitable for the massive recurring payment processing, but you can also use Sips Office.
You debit or credit your subscribers at different due dates (in the case of prepaid services where the subscriber has to charge his account before consuming). X V X X X V The transactional mode is Sips Office the connector that is suitable for debiting or crediting your subscribers with varying due dates.
Means of payment expiry
Renew the subscriber's means of payment. Renewal is treated as subscription taking out. Reuse the same connector used for subscription taking out.
Initialising the subscriber base
You are migrating an existing subscriber base. X X X X V X Sips Office Batch allows you to initialise the subscriber base from an existing database.

The collection of payment details is done on Sips Paypage.

If the subscriber's means of payment is a card:

  • The subscriber must necessarily authenticate himself with the 3-D Secure system.
  • You can use the field authenticationData.authentAmount to authenticate an amount different from the amount to be paid on the first due date.
  • You must keep the transaction reference in your information system, in order to debit your subscriber for future due dates.

Diagram describing the enrolment of the subscriber via Paypage

  1. During the subscription taking out phase, you redirect the new subscriber to Sips Paypage by including the transaction data in the request (amount of the first due date, currency, etc.).
  2. WL Sips displays the payment page, the subscriber provides their payment details and then validates.
  3. WL Sips performs the 3-D Secure checking.
  4. WL Sips performs anti-fraud checks.
  5. WL Sips sends an authorisation request to the acquirer.
  6. WL Sips saves the transaction in the back office.
  7. WL Sips returns you the manual and automatic responses containing the transaction details. You store your transaction reference and the card expiry date.
  8. WL Sips sends or does not send the transaction based on the terms you set in the payment request.

This consists in a classic Sips Paypage request, please refer to one of the Sips Paypage guides to learn how to populate the request based on your business needs.

However, the following fields have a particular behaviour and should be valued like this:

Field Value
paymentPattern RECURRING_1
challengeMode3DS CHALLENGE_MANDATE
captureDay 0 to 6
captureMode AUTHOR_CAPTURE or VALIDATION
amount amount of the first due date (can be valued at 0 if the first due date is free or if the first payment takes place later)
authentAmount to be valued if the amount field = 0 with the average amount of a payment occurrence of the subscription.

If the field is not filled in, the authentication amount will be the same as the one indicated in the amount field.

WL Sips returns a classic manual and automatic Sips Paypage response.

The fields pertaining to subscription taking out are as follows:

Status Response fields Actions to perform
Transaction accepted (subscription taken out successfully) ResponseCode = 00 Store the transaction reference in your customer base:
You can submit recurring payments.
Transaction declined (subscription taking out declined) ResponseCode = XX (not 00) Read the Sips Paypage connector guide to analyse the response from WL Sips.

Collecting payment details is done on your e-commerce site.

You then use two methods:

  • cardCheckEnrollment: checks the 3-D Secure enrollment of the card (see the JSON or SOAP WL Sips documentation to find out the full parameters of the request).
  • cardValidateAuthenticationAndOrder: cardholder authentication and authorisation request (see the JSON or SOAP WL Sips documentation to find out the full parameters of the request).

For the cardCheckEnrollment method, these fields have a particular behaviour and should be valued as follows:

Field Value
paymentPattern RECURRING_1
challengeMode3DS CHALLENGE_MANDATE
authenticationData.authentAmount amount of the first due date of the subscription (may be valued at 0 if the first due date is free of charge, for example, or if the first payment is not made until later)
authentAmount to be valued if the amount field = 0 with the average amount of a payment occurrence of the subscription.

If the field is not filled in, the authentication amount will be the same as the one indicated in the amount field.

captureDay 0 to 6
captureMode AUTHOR_CAPTURE or VALIDATION
Attention: You must keep the transaction reference in your information system, in order to debit your subscriber for future due dates.

Once the subscription taking out is accepted, you can debit subscriber batches using file transfer with Sips Office Batch, thanks to transaction duplication. Transactions are automatically chained by WL Sips.


Diagram describing the subscriber flow via Sips Office Batch

You format a Sips Office Batch file consisting of duplicate requests.

Each duplicate record includes:

The chain of steps is as follows:

  1. You send the file to WL Sips via FTPS or SFTP.
  2. WL Sips retrieves the subscriber’s payment details.
  3. WL Sips runs fraud checks you set up on your shop.
  4. WL Sips sends the authorisation requests to acquirers.
  5. WL Sips stores the transaction in the back office.
  6. WL Sips formats the response file and returns it to you.
  7. In the evening, WL Sips sends the remittances for accepted transactions.

Please read the Sips Office Batch XML or Sips Office Batch CSV guides for details on the implementation (file structure, records description, file transfer, error handling, etc.).

To generate a recurring payment using the duplicate method, you need to populate the following fields:

Field Value Comment
FromTransactionReference or fromS10TransactionReference.fromS10TransactionId / fromS10TransactionReference.fromS10TransactionIdDate pair The reference of the transaction made when taking out the subscription
or
The reference of the transaction made on the last modification of the means of payment
amount The amount of the due date

Please refer to the Sips Office Batch XML or Sips Office Batch CSV guides to find out how to populate the other fields in the request depending on your business need.

Status Response fields Actions to perform
Transaction accepted ResponseCode = 00 The next day, check in the Transactions report that the sending for remittance has been completed (TransactionStatus = CAPTURED).
Transaction refused ResponseCode = XX Please refer to the Sips Office Batch connectors guides to analyse the response from WL Sips.

The Sips Office JSON/SOAP connector also provides the duplicate method in message mode with the same rules as Sips Office Batch for request formatting and response analysis.

Please refer to one of the Sips Office guides for implementation details.

Since you have stored the means of payment expiry date when taking out a subscription, you can alert your subscriber long enough before the expiry date, so as to ask them to return to your e-commerce site and renew their means of payment.

The renewal of the means of payment must be handled in the same way as when taking out a subscription. Once the new means of payment has been entered and validated, store the new means of payment expiry date and the new transaction reference for use at future recurring debits.

Here is an example of a subscription payment with a first due date within 6 days:


Example of a subscription where the first payment is less than 6 days away

Connectors :

CIT MIT
Connector
  • Sips Paypage
  • Sips Office
  • Sips In-App
  • Sips Office
  • Sips Office Batch

Parameters of the request :

champ CIT MIT
paymentPattern RECURRING_1 X
ChallengeMode3DS CHALLENGE_MANDATE X
captureDay [ 0 , 6 ] [ 0 , 99 ]
captureMode
  • AUTHOR_CAPTURE
  • VALIDATION
  • AUTHOR_CAPTURE
  • VALIDATION
amount Amount of the fisrt due date amount of nth due date
authentAmount Average amount of due dates X

Here is an example of a subscription payment with a first due date of more than 6 days:


Example of a subscription payment with a first payment due in more than 6 days

On July 28th 2021, day of the order (CIT) with authentication at 10 euros and an card information request triggered by an amount of EUR 0. The duration of the authorisation request runs from 28 July to 3 August (6 days). On August 5th 2021, i.e. D+8, triggering of the 1st due date (MIT1) which leads to a chained authorisation request with the CIT and a remittance without 3DS data of 10 euros. On August 15th 2021, i.e. D+34, triggering of the 2nd due date (MIT2) which leads to a chained authorisation request with the CIT and a remittance without 3DS data of 10 euros.

Connecteurs :

CIT MIT
Connecteur
  • Sips Paypage
  • Sips Office
  • Sips In-App
  • Sips Office
  • Sips Office Batch

Paramètres de la requête :

champ CIT MIT
paymentPattern RECURRING_1 X
ChallengeMode3DS CHALLENGE_MANDATE X
captureDay 0 [ 0 , 99 ]
captureMode X
  • AUTHOR_CAPTURE
  • VALIDATION
amount 0 amount of nth due date
authentAmount Average amount of due dates X

When you have chosen the WL Sips interfaces that meet your needs (see the 'Choosing the WL Sips connectors for subscription' section), will you need to integrate the connectors to connect your site to WL Sips and to follow the instructions in the 'Implementation' section.

Once you have implemented the WL Sips connectors, you can do some tests to validate your integration.

test data
merchantId 201000076690001
secret key p64ifeYBVIaRcjaWoahCiw9L8wokNLqG2_YOj_POD4g
secret key version 1
test cards Cf. the "Test cards" page

Server Test URL
Paypage POST https://payment-webinit.test.sips-services.com/paymentInit
Paypage JSON https://payment-webinit.test.sips-services.com/rs-services/v2/paymentInit
Paypage SOAP https://payment-webinit.test.sips-services.com/services/v2/paymentInit
Office https://office-server.test.sips-services.com
IMPORTANT: the test shop is configured in "transactionReference mode", with no automatic generation of the transactionReference. Therefore, you need to send the populated transactionRefence field in your test requests.

Your shop is not registered with WL Sips.

If your shop has not yet been registered, you must fill in the registration form and return it to Worldline.

Your shop is already registered withWL Sips.

If your shop is already registered with WL Sips, you must confirm with Worldline that you have access to Sips Office Batch or Sips Office.

You must change the URL to connect to the WL Sips production server using the credentials you received when registering merchangtId, secretKey, and keyVersion.

WL Sips URL URL of the WL Sips payment server retrieved by e-mail.
MerchantId Shop ID received by e-mail.
SecretKey Secret key you retrieve via the Sips Download extranet.
KeyVersion Secret key version retrieved on Sips Download (obviously 1 for the 1st key).
Tip: a common mistake is to forget one of these four parameters, which always leads to an error.

If you want to customize your payment pages, please follow the procedure described in the Custompages documentation.

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.

Configuration