WL SIPS DOCS

Release 24.6

go directly to content

Search by keywords

  1. 3-D Secure and Payment use cases
  2. Payment in instalments

Payment in instalments

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

It is advised to read the following documents before

  • Recommended
    1. 3-D Secure and Payment use cases

    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

Introduction

Worldline 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 of the payment in instalments solution until the production starts.

Who does this document target

This document is intended to help you implement the payment in instalments.

The purpose is to present the functionalities related to the payment in instalments and to explain how to implement them with the Worldline Sips solution.

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

  • Functional presentation
  • Functionality set-up guide
Attention: Worldline Sips does not manage the personal data of your customers (name, first name, address, age, e-mail, telephone ....) but only payment details allowing to debit or credit your subscribers.

Prerequisites

Your customers' payment details must be stored in Worldline Sips to allow you to make payments in instalments.

You have some points to process before starting:

  • to be in compliance with the GDPR, you have to fill in your internal personal data processing register, specifying that banking data are maintained by Worldline Sips. For more information on the GDPR, please refer to our documentation on information systems security;
  • inform your customers about the storage of their details and the terms of payment in instalments (amount, number of instalments, ...);
  • verify with your acquirer that your contract supports recurring payments.

Overview of the payment in instalments service

The payment in instalments has several components:

  • setting up the due date when the first instalment is paid;
  • processing of the subsequent due dates;
  • management of the customer's means of payment expiration or of the one due dates refusal.

The payment methods allowing recurring payments to be made are : CB, Visa, Mastercard and Amex.

Choice of Worldline Sips connectors for payment in instalments

As Worldline Sips offers several interfaces to process payment in instalments, it is important to analyse your business needs to choose the most appropriate connectors for your situation.

There are two different integration modes for creating payments in instalments:

  • via Sips Paypage: you send the details of each due date to Worldline Sips: an authorisation will be made to pay the first instalment when getting the order. If the payment is accepted, all the instalments will be effectively created and sent to the bank on the requested date;
  • via Sips Office, Sips Office Batch or Sips Office Extranet: you call Worldline Sips at each new due date: during the first payment Worldline Sips will process only this payment. You will have to call Worldline Sips again at each due date using one of the following methods:
    • Duplicate the first transaction (duplicate function)
    • By creating a new transaction:
      • via Sips Office Extranet or
      • cardOrder function with the token of the CIT card number or
      • walletOrder function with the ID of the Sips WL wallet in which the CIT card is stored.

The table below summarises the available interfaces according to these two modes.

Use cases Sips Paypage Sips Office Sips Office Batch Sips In-App Sips Office Extranet
Order placement and first due date (CIT) V V X V X
Subsequent due dates (MIT) Managed automatically by Worldline Sips Managed by the merchant Managed by the merchant X V

Data to retain

Depending on how you process due dates, the data to be retained varies:

Connector Data to be retained for processing MIT
Sips Paypage X
Sips Office via Duplication function
  • CIT reference (field transactionReference or s10TransactionId / s10TransactionDate)
Sips Office via cardOrder function (with token)
  • CIT reference (field transactionReference or s10TransactionId / s10TransactionDate)
  • Unique transaction reference of the issuer used for chaining (field schemeTransactionIdentifier)
  • Token of the card used in the CIT (field tokenPan)
  • Brand of the card used in the CIT (field paymentMeanBrand)
  • Expiry date of the card used in the CIT (field cardExpiryDate)
Sips Office via walletOrder
  • CIT reference (field transactionReference or s10TransactionId / s10TransactionDate)
  • Unique transaction reference of the issuer used for chaining (field schemeTransactionIdentifier)
  • Wallet identifier used for the CIT (field merchantWalletId)
  • ID within wallet of the card used in the CIT (field paymentMeanId

Implementation

As a reminder, the customer must authenticate with 3-D Secure. The amount to be authenticated must be equal to the total amount of the order. For this type of payment, no exemption to strong authentication can be granted. For regulatory reasons, frictionless is not possible when setting up a payment in several instalments, there will necessarily be an authentication in Challenge mode. This first first due date benefits from the payment guarantee (unlike the following due dates).

The means of payment must be valid on the last due date (for example, in the case of cards, the expiration date shall not exceed the last due date). Otherwise, the payment will be refused.

Payment in instalments with Sips Paypage

When the different payments are set up with Sips Paypage, all the instalments will be created when the bank details are entered, as soon as the first payment is accepted.

Order placement and 1st due date: CIT
Description

Diagram describing the order placement and 1st due date via Paypage

  1. To set up the instalment payment, you redirect the customer to Sips Paypage by providing detailed information on all the deadlines in the request (reference, desired settlement date, amount, etc.).
  2. Worldline Sips displays the payment page (only payment methods that support instalment payments are available), the customer selects the mean of payment, provides their payment details and then validates.
  3. Worldline Sips performs the 3-D Secure verification.
  4. Worldline Sips performs anti-fraud checks.
  5. Worldline Sips sends a request for authorisation to the acquirer.
  6. Worldline Sips records one transaction per due date in the back office.
  7. Worldline Sips returns manual and automatic responses containing the details of the transaction.
  8. Worldline Sips sends the transaction to settlement (if applicable) according to the terms you set up in the payment request.

Payment page display

  • display of each date and amount, if less than 5 due dates:

    Screenshot of the paypage displaying the instalments if less than 5

    In the "Transaction information" block, under the section entitled "Instalments", each instalment with date and amount is displayed one below the other.
  • display of the number of due dates, the start and end dates of the transactions, if more than 5 due dates :


    In the "Transaction details" block, in the section entitled "Payment in x instalments" (x being the number of instalments), the following is displayed : First instalment: "first instalment date: amount" Followed by x instalments, from "first instalment date +1" to "last instalment date".

    At the end of the process, the receipt displays the details of the due dates:


    Screenshot of the ticket showing the details of the due dates

    Below the message indicating that the payment has been accepted is a table with the instalment date in the first column, the amount in the second column and the transaction reference in the third column
Setting the request

You need to fill in some parameters specifically to request the creation of an instalment payment.

Field Value setting rule
paymentPattern INSTALMENT
challengeMode3DS forced to CHALLENGE_MANDATE
captureMode Forced by Sips Paypage to AUTOR_CAPTURE regardless of the transmitted value.
captureDay Ignored by Sips Paypage, the dates provided in the instalmentData.datesList field make a reference.
amount Must be equal to the sum of the due dates amounts transmitted in the list instalmentData.amountList
instalmentData.number number of due dates
instalmentData.datesList The dates of each due date:
  • must be unique;
  • transmitted in chronological order;
  • the time between the first and last date may not exceed the legal duration of the instalment payment (90 days) free of charge.
instalmentData.transactionReferencesList List of the transactionReference of each due dates. The first element of the list must be equal to the transactionReference field of the request.
instalmentData.amountsList List of transmitted due date amounts in due date order. The sum of the amounts must be equal to the amount field .

Please refer to one of the Sips Paypage guides to know how to populate the other fields.

Analysing the response

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

The subscription related fields are as follows:

Status Response fields

Transaction accepted (first payment made successfully).

responseCode = 00

acquirerResponseCode = 00

Transaction refused (first payment refused).

 responseCode = XX (other than 00)
Please view the Sips Paypage connector guide to analyse the response of Worldline Sips.
Processing the subsequent due dates

Worldline Sips processes the subsequent due dates automatically according to the requested remittance dates. This means that for each due date, Worldline Sips will perform automatically an authorisation and remittance request (if applicable) on the requested day.

Worldline Sips will combine each due date (MIT) with the transaction created during the first payment (CIT).

You can view the results of these transactions in your transaction report or on Sips Office Extranet.

Paymenent in instalments with Sips Office

You have the possibility to manage each due date of a payment in instalments with Sips Office.

First, you make the initial payment to set up the due date. If this first payment is successful, several options are available:

  • Duplicate the first transaction: combination is done by Worldline Sips
  • create new transactions using the cardOrder or walletOrder method: you must perform the CIT-MIT combination yourself.
Order placement and 1st due date: CIT

Description

Diagram describing the order placement and 1st due date via Office

  1. You display the payment due date on your website pages and ask your customer to enter their bank details.
  2. You make a request to Sips Office, communicating in the request the detailed information about the overall order and the first due date.
  1. Worldline Sips performs the 3-D Secure checking.
  2. Worldline Sips performs anti-fraud checks.
  3. Worldline Sips sends an authorisation request to the acquirer.
  4. Worldline Sips saves the first due date in the back office.
  5. Worldline Sips returns the result of the payment in the response.
  6. Worldline Sips sends the transaction in remittance (if applicable) according to the terms you set up in the payment request.
Setting the request

The cardCheckEnrollment and walletCheckEnrollmentmethods allow you to initiate a payment in instalments with Sips Office.

You have to fill in some specific parameters to request the creation of this type of payment.

Field Value setting rule
paymentPattern INSTALMENT
challengeMode3DS forced to CHALLENGE_MANDATE
amount Must be set to the amount of the first due date.
authenticationData.authentAmount Must be set to the overall order amount.
recurringData.recurringSequence Must be set to 1 (the sequence of the due date in process).
recurringData.recurringSequenceMax Must be set to the total number of due dates.
recurringData.recurringPeriod Must be set to the minimum number of days between two consecutive due dates.
recurringData.recurringEndDate Must be set to the last scheduled due date;

Please view one of the Sips Office guides to know how to populate the other fields.

Analysing the response

According to the response returned by Sips Office, you determine the progress of this payment in instalments:

Status Response fields Action to take

Transaction accepted (first payment made successfully).

responseCode = 00

acquirerResponseCode = 00

You can process the order according to the required guarantee level (guaranteeIndicator field).

You keep the reference of this first transaction (CIT) which will be used for the subsequent due dates.

Transaction refused (first payment refused).

 responseCode = XX (other than 00)

Please view the Sips Office connector guide to analyse the response of Worldline Sips.

You can offer your customer to pay with another means of payment by generating a new request.
Processing the subsequent due dates
Via duplicate method

Calling up the duplication function allows you to make the payment for each subsequent due date (MIT).

Sips Office is responsible for chaining each due date (MIT) with the transaction created at the time of the first payment (CIT).

Consult the connector guideSips Office or Sips Office Batch to set up the call to the duplicate method.

Via cardOrder or walletOrder method

Worldline Sips offers two options to duplication method for the processing of the following deadlines:

Using the cardOrder method from the card number token returned in the response to the CIT. In addition to the standard fields in the method, you must send the following fields:

Field Value
cardNumber value of the tokenPan field received in response from the CIT
panType TOKEN_PAN
cardExpiryDate card expiry date
cardEffectiveDate if card and acquirer UK
cardSequenceNumber if card and acquirer UK
paymentPattern RECURRING_N
initialSchemeTransactionIdentifier value of the schemeTransactionIdentifier field received in response from the CIT

Use of the walletOrder method if the card has been previously registered in the wallet Worldline Sips (at the time of the CIT or earlier for a previous purchase). In addition to the standard fields of the method, you must send the following fields:

Field Value
paymentPattern RECURRING_N
initialSchemeTransactionIdentifier value of the schemeTransactionIdentifier field received in response from the CIT
merchantWalletId ID of the wallet in which the card used in the CIT is stored
paymentMeanId ID of the card used in the CIT within the wallet Worldline Sips
For all the fields of the cardOrder and walletOrder methods, please refer to the connectors' documentations Sips Officeand Sips Office Batch.

Summary

Sips Paypage

Here is an example of payment in instalments with the connector :

Payment of an order of 900€ in three installments of 300€ each

  • Day of order
    • 3DS v2 authentication with total order amount (mandatory challenge): 900€.
    • Authorisation request with 3DS data, first instalment: 300€
    • Settlement without 3DS data: 300€
  • Day of the 2nd due date
    • CIT chained authorisation request: 300€
    • Settlement without 3DS data: 300€
  • Day of the 3rd due date
    • CIT chained authorisation request: 300€
    • Settlement without 3DS data: 300€

example of payment in instalments on Paypage

Parameters of the request:

Field CIT MIT
paymentPattern INSTALMENT Managed by Worldline Sips
challengeMode3DS CHALLENGE_MANDATE
captureMode AUTHOR_CAPTURE
amount Sum of the due date amounts
instalmentData.datesList Dates of each due dates
instalmentData.transactionReferencesList TransactionReference of each due dates
instalmentData.amountsList Amount of each due dates
instalmentData.number Number of due dates

Other connectors

Payment in several instalments with 1st payment less than 6 days away

Here is an example of a payment in instalments with a first payment within 6 days:

Payment of an order of 500€ in 2 instalments:

  • Day of order
    • 3DS v2 authentication with total order amount (mandatory challenge): 500€.
    • Authorisation request with 3DS data, first due date: 250€.
  • Day of 1st due date
    • Settlement with 3DS data: 250€
  • Day of 2nd due date
    • CIT chained authorisation request without 3DS data: 250€.
    • Settlement without 3DS data: 250€

Example of a payment in several instalments with the first payment within 6 days

July 28th 2021 day of the order (CIT) with an authentication of the total amount of the order, i.e. EUR 500 and an authorisation request for the amount of the first instalment, i.e. EUR 250. The duration of the authorisation request runs from 28 July to 3 August (6 days). On August 2nd 2021, i.e. D+4, the delivery with the 3DS data of the first instalment (CIT) for 250 euros takes place. On September 9th 2021, i.e. D+31, triggering of the 2nd deadline (MIT1) resulting in a chained authorisation request with the CIT and a remittance in 3DS data for an amount of 250 euros.

Connectors:

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

Parameters of the request:

Field CIT MIT via duplicate MIT via cardOrder or walletOrder
paymentPattern INSTALMENT X INSTALMENT
challengeMode3DS CHALLENGE_MANDATE X X
captureDay [ 0 , 6 ] [ 0 , 99 ] [ 0 , 99 ]
captureMode AUTHOR_CAPTURE
  • AUTHOR_CAPTURE
  • VALIDATION
  • AUTHOR_CAPTURE
  • VALIDATION
amount Amount of the fisrt due date amount nth due date amount nth due date
authenticationData.authentAmount Total amount of the order X X
recurringData.recurringSequence 1 X Due date number
recurringData.recurringSequenceMax Total number of due dates X X
recurringData.recurringPeriod Maximum number of days between 2 consecutive due dates X X
recurringData.recurringEndDate Date of the last due date X X
initialSchemeTransactionIdentifier X X value of the schemeTransactionIdentifier field received in response from the CIT
Payment in several instalments with 1st payment more than 6 days away

Here is an example of a payment in instalments with a first payment more than 6 days:

Payment of an order of 500€ in 2 instalments:

  • Day of order
    • 3DS v2 authentication with total order amount (mandatory challenge): 500€.
    • Information request : authorisation with 3DS data: 0€.
  • Day of 1st due date
    • CIT chained authorization request without 3DS data: 250€.
    • Settlement without 3DS data: 250€
  • Day of 2nd due date
    • CIT chained authorisation request without 3DS data: 250€.
    • Settlement without 3DS data: 250€

Example of a payment in several instalments with the first payment more than 6 days away

July 28th, 2021, the day of the order (CIT) with an authentication of the total amount of the order, i.e. EUR 500 and a 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, the 1st deadline (MIT1) is triggered, resulting in a chained authorisation request with the CIT and a remittance without the 3DS data for an amount of 250 euros. On September 5th 2021, i.e. D+38, triggering of the 2nd deadline (MIT2) resulting in a chained authorisation request with the CITand a remittance in 3DS data for an amount of 250 euros.

Connectors:

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

Parameters of the request:

Field CIT MIT via duplicate MIT via cardOrder or walletOrder
paymentPattern INSTALMENT X INSTALMENT
challengeMode3DS CHALLENGE_MANDATE X X
captureDay [ 0 , 6 ] [ 0 , 99 ] [ 0 , 99 ]
captureMode X
  • AUTHOR_CAPTURE
  • VALIDATION
  • AUTHOR_CAPTURE
  • VALIDATION
amount 0 amount nth due date amount nth due date
authenticationData.authentAmount Total amount of the order X X
recurringData.recurringSequence 1 X Due date number
initialSchemeTransactionIdentifier X X value of the schemeTransactionIdentifier field received in response from the CIT

Starting payment in instalments in 4 steps

Step 1 - Implementing the service

When you have chosen the Worldline Sips interfaces that meet your needs (cf. the paragraph Choice of connectors), you have to integrate the connectors to connect your website to Worldline Sips and follow the instructions in the Implementation section.

Your shop must be configured on Worldline Sips to accept payment in instalments. You have to ask Worldline to activate this service on your shop if it is not already done.

Step 2 - Testing the service on the test environment

Once you have implemented the Worldline 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 page "Test cards"

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 transactionReference field in your test requests.

Step 3 - Subscribing to the production service

Your shop is not registered on Worldline 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 with Worldline Sips.

If your shop is already registered with Worldline Sips, you must check with Worldline to ensure to have access to Sips Paypage or Sips Office.

Step 4 - Starting and validating the service in production

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

URL Worldline Sips URL of the Worldline Sips payment server retrieved by e-mail.
MerchantId Shop ID received by e-mail.
SecretKey Secret key you retrieve via the Sips Download.
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 customise your payment pages, please follow the procedure described in the Custompages documentation.

Back to top Need help?

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