Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata


About Limonetik

General information about Limonetik

In France, Computop customers can offer the local payment methods Cofidis, 1euro.com, Cetelem and Facilypay which specialize in instalment payments for credit card transactions. Online shoppers can pay for orders conveniently by credit card, however are not charged to the full amount in a one-off transaction but in fixed instalments over several months. Merchants receive the amount due immediately after the order has been actuated and so have high payment security. In addition to the instalment payment methods, Computop offers Cheque-Vacances (eANCV) and its wallet version Cheque-Vacances Connect (cvconnect), a payment method which enables shoppers to shop online with vouchers. With the new payment methods which are extremely popular in France, merchants can achieve a increase in their turnover rates in French eCommerce.


Logo
Info

In France, Computop customers can offer the local payment methods Cofidis, 1euro.com, Cetelem and Facilypay which specialize in instalment payments for credit card transactions. Online shoppers can pay for orders conveniently by credit card, however are not charged to the full amount in a one-off transaction but in fixed instalments over several months. Merchants receive the amount due immediately after the order has been actuated and so have high payment security.

TypeMixed payment methods EN


Further information can be found on the webpage of Limonetik (www.limonetik.com/en/).

 

Process flow chart


Limonetik process flow


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Call of Paygate interface for Limonetik

To make a payment with Limonetik over a Paygate form, go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

TaxAmount

n..12

O

Tax amount of the entire order in the smallest currency unit (e.g. EUR Cent).

Currency

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..128

O

Description of purchased goods, unit prices etc.

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

Important Note: Please contact the Computop Support to discuss the different fields of application for Manual.

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

PayType

ans..21

M

Payment method that shall be used. Possible values:

cofidis3xcb

cofidis4xcb

1euro

echequevacances

facilypay-3x

facilypay-3xsansfrais

facilypay-4x

facilypay-4xsansfrais

cvconnect

cetelem3xcb

cetelem4xcb

upchequedejeuner

apetiz

passrestaurant

sofinco2xcb

sofinco2xcbsansfrais

sofinco3xcb

sofinco3xcbsansfrais

sofinco4xcb

sofinco4xcbsansfrais

Invoicing address

CompanyName

ans..50

C

Company name, if shop delivery, StorePickup, Network-Pickup or TravelPickup is selected

CustomerID

ans..20

C

Customer number

Mandatory with Facilypay and Sofinco

CustomerClassification

a..12

C

Hint about customer type. Possible values: Professional, Individual

Mandatory with Facilypay

CustomerInformation

ans..100

C

Additional information about the customer. For Cetelem the merchant can submit several values separated by | which are agreed between merchant and Cetelem. Example: CustomerInformation =CFID=true|CNEW=false

Mandatory with Facilypay, Cetelem

Salutation

ans..20

C

Salutation

Mandatory with Facilypay, Cetelem and Cofidis

FirstName

ans..50

C

First name

Mandatory with Facilypay, Cetelem and Cofidis

LastName

ans..50

C

Last name

Mandatory with Facilypay, Cetelem and Cofidis

Street

ans..80

C

Street name and street number

Mandatory with Facilypay, Cetelem and Cofidis

AddressAddition

ans..80

O

Address c/o

ZIPCode

ans..10

C

Postcode

Mandatory with Facilypay, Cetelem and Cofidis

City

ans..100

C

City

Mandatory with Facilypay, Cetelem and Cofidis

CountryCode

a2

C

Two characters country code according to ISO 3166-1 alpha-2

Mandatory with Facilypay, Cetelem and Cofidis

Email

ans..100

C

E-mail address

Mandatory with Facilypay, Cetelem, Cofidis, CVConnect and Cheque-Vacances (eANCV) with split payments, Sofinco (all connected pay types), upchequedejeuner, apetiz, passrestaurant

Phone

ns..50

OC

Phone number: is not mandatory for FacilyPay and Cetelem if parameter MobileNo is transmitted.

e.g. +49123456789

Mandatory with Cofidis

MobileNo

ns..50

OC

Mobile phone number: is not mandatory for FacilyPay and Cetelem if parameter Phone is transmitted.

e.g. +49123456789

Mandatory with Cofidis

Language

as5

O

Language for displaying the form. Default value: fr-FR

Delivery address

sdCompanyName

ans..50

C

Company name in the delivery address

Mandatory with Facilypay if ShippingData Type StorePickup, NetworkPickup, TravelPickup or Other is selected

sdSalutation

ans..20

C

Salutation in the delivery address

Mandatory with Facilypay, Cetelem and Sofinco

sdFirstName

ans..50

C

First name in the delivery address

Mandatory with Facilypay, Cetelem and Sofinco

sdLastName

ans..50

C

Last name in the delivery address

Mandatory with Facilypay, Cetelem and Sofinco

sdStreet

ans..80

O

Street name and street number in the delivery address

Mandatory with Facilypay, Cetelem and Sofinco

sdAddressAddition

ans..80

O

Address addition in the delivery address

sdZipCode

ans..10

C

Postcode in the delivery address

Mandatory with Facilypay, Cetelem and Sofinco

sdCity

ans..100

C

Town/city in the delivery address

Mandatory with Facilypay, Cetelem and Sofinco

sdCountryCode

a2

C

Country code for the delivery address, 2 characters according to ISO 3166-1.

Mandatory with Facilypay, Cetelem and Sofinco

sdPhone

ans..50

OC

Phone number: is not mandatory for FacilyPay and Cetelem if parameter MobileNo is transmitted.

e.g. +49123456789

sdMobileNo

ans..50

OC

Mobile phone number: is not mandatory for FacilyPay and Cetelem if parameter Phone is transmitted.

e.g. +49123456789

Product information

ArticleList

ans..1024

C

Article list. Mandatory with Facilypay.

These parameters must have the following structure:

ID,Description,UnitPrice,Quantity,Category,Brand

Several articles can be separated with a +, e.g.: 123,iPhone 6s,700,1,Phones,Apple+321,Galaxy S7,700,2,Phones,Samsung


Possible values for Category:

     ComputersAndSoftware

     Electronics

     Phones

     Appliances

     HomeAndGarden

     Fashion

     HealthAndBeauty

     Jewellery

     Sport

     LeisureAndHobbies

     CarsAndMotorbikes

     Furniture

     KidsAndBaby

     VideoGamesAndConsoles

     ToysAndGames

     Pets

     FoodAndDrink

     GiftAndFlowers

     Entertainment

     Travel

     AuctionsAndGroupBuying

     ServicesForIndividuals

     ServicesForProfessionals

ShippingData

ans..1024

C

Delivery data. Mandatory with Facilypay.

These parameters must have the following structure:

Type,Description,Speed,ExpectedDate,ExpectedDelay


e.g.: Other,DHL,Standard,2016-06-30,3


Possible values for Type:

     StorePickup

     NetworkPickup

     TravelPickup

     Carrier

     EDelivery

     Other


Possible values for Speed:

     Express

     Standard

Parameters for payments with Limonetik


The following table describes the result parameters that the Paygate transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

RefNr

ns..30

O

Unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..256

C

Error code from Limonetik.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support.

ErrorText

ans..256

C

Detailed Limonetik error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

TransactionID

ans..50

O

ID for identification of payment form

Results parameters for URLNotify, URLSuccess and URLFailure



Capture

Captures are possible via a Server-to-Server connection. To carry out a Capture for Limonetik via a Server-to-Server connection please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be captured

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency code, three digits DIN / ISO 4217

RefNr

ns..30

O

Merchant’s unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for Limonetik captures


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ns..30

M

Merchant’s unique reference number

Result parameters for Limonetik captures



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture. To carry out a credit with a reference transaction, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

Notice: With Facilypay a refund usually is possible only 48 hours after the payment. Limonetik stores the refund request and retries the request to Facilypay until this will be processed. During this time the transaction is “Suspended” and no other refunds are possible.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency code, three digits DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for credits of Limonetik payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Result parameters for credits of Limonetik payments



Reversal

To cancel a transaction with Limonetik, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be reverted

TransID

ans..64

M

Merchant ID for the identification of the payment process to be reversed

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency code, three digits DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for reversals of Limonetik payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Result parameters for reversals of Limonetik payments



Batch processing via the interface

Basic information about using Batch files and about their structure you can find inside the separate manual for the Batch manager. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing of captures, credits and reversals for Limonetik and which information can be found within the response file about the payment status.

Following table gives an overview of all batch versions that are possible for a specific action an their specialities:

Action

Version

Description

Capture

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Reverse

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


The structure for a Limonetik payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>

Limonetik,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

Limonetik,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

Limonetik,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


The following table describes the individual fields and values used within the data set (record) in the batch file:

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, Limonetik for Limonetik

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

Description of fields within the record for Batch files

 

 

The record area within the response file for Batch transactions looks the following way:

HEAD,<MerchantID>,<Date>,<Version>

Limonetik,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

Limonetik,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

Limonetik,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

 

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Description of result parameters within the record for Batch files