Description of all parameters

Basic settings
Logs	Allows to enable or disable module logs. The logs will be available in the /var/logs, /log or /app/logs/ directory depending on your version of Prestashop. The module generates 1 log file per month. This parameter is enabled by default.

Basic settings

Logs

Allows to enable or disable module logs.

The logs will be available in the /var/logs, /log or /app/logs/ directory depending on your version of Prestashop.

The module generates 1 log file per month.

This parameter is enabled by default.

Access to the payment gateway
Shop ID	Indicate the 8-digit shop ID, available in your Expert Back Office (Menu: Settings > Shop > Keys).
Test key	Specify the test key available via your Expert Back Office (Menu: Settings > Shop > Keys).
Production key	Specify the production key available in your Expert Back Office (Menu: Settings > Shop > Keys).
Mode	Allows to indicate the operating mode of the module (TEST or PRODUCTION). The PRODUCTION mode becomes available only after the test phase has been completed. The TEST mode is always available.
Signature algorithm	Algorithm used to compute the signature of the payment form. The algorithm must be the same as the one configured in the Expert Back Office (Settings > Shop > Keys). If the algorithm is different, the parameter will have to be modified via the Expert Back Office.
Instant Payment Notification URL	URL to copy in your Expert Back Office (Settings > Notification rules > Instant Payment Notification URL at the end of the payment > Instant Payment Notification URL of the API form V1, V2 menu). For more information, see the chapter and the sub-chapters on Configuring the notification URL.
Payment page URL	This field is pre-populated by default: https://secure.lyra.com/vads-payment/

REST API keys
Test password	Password allowing to use Web Services or embedded payment fields in test mode. The password is available in your Expert Back Office (Menu: Settings > Shops > REST API keys).
Production password	Password allowing to use Web Services or embedded form in production mode. The password is available in your Expert Back Office (Menu: Settings > Shops > REST API keys).
REST API server URL	This field is pre-populated by default: https://api.lyra.com/api-payment/ It is recommended to leave the default value.
Public test key	The test public key must be filled in if you use the embedded payment fields, such as Card data entry mode. The public key is available via your Expert Back Office (Menu: Settings > Shops > REST API keys).
Public production key	The production public key be must be filled in if you use the embedded payment fields, such as Card data entry mode. The public key is available via your Expert Back Office (Menu: Settings > Shops > REST API keys).
HMAC-SHA-256 test key	The test HMAC-SHA--256 key must be filled in if you use the embedded payment fields, such as the Card data entry mode. The HMAC-SHA-256 key is available from your Expert Back Office (Menu: Settings > Shops > REST API keys).
HMAC-SHA-256 production key	The production HMAC-SHA--256 key must be filled in if you use the embedded payment fields, such as the Card data entry mode. The HMAC-SHA-256 key is available from your Expert Back Office (Menu: Settings > Shops > REST API keys).
REST API Instant Payment Notification URL	URL to copy in your Expert Back Office (Settings > Notification rules > Instant Payment Notification URL at the end of the payment > REST API Instant Payment Notification URL menu). For more information, see the chapter and the sub-chapters on Configuring the notification URL.
JavaScript client URL	This field is pre-populated by default: https://static.lyra.com/static/ It is recommended to leave the default value.

Payment page
Default language	This option allows to choose the default language of the payment page in case the language of PrestaShop is not supported by Lyra Collect. If the language(s) used by the PrestaShop is (are) implemented into Lyra Collect, the payment page will be displayed in the language of PrestaShop when the buyer clicks on “Pay”.
Available languages	Allows to customize the language displayed on the payment page. The buyer will be able to select a language when he or she is redirected to the payment page. If you do not select any language, all languages will be displayed on the payment page. To select a language, press and hold the “`Ctrl`” key and click on the desired languages. Available languages: German, English, Chinese, Spanish, French, Italian, Japanese, Dutch, Polish, Portuguese, Russian, Swedish, Turkish.
Capture delay	Indicates the delay (in days) before the capture. By default, this parameter can be configured in your Expert Back Office (Menu: Settings > Shop > Configuration - section: Capture delay). It is recommended to not populate this parameter.
Validation mode	*Back Office configuration:* Recommended value. Allows to use the configuration defined in the Expert Back Office (Menu: Settings > Shop > Configuration section: validation mode). *Automatic:* This value indicates that the payment will be captured in the bank automatically without any action on the merchant’s part. *Manual:* This value indicates that the transactions will require manual validation by the merchant via the Expert Back Office. Warning: if the transaction is not validated by the merchant before the expiration date of the authorization request, it will never be captured in the bank. Remember to configure the Instant Payment Notification rule on an operation coming from the Back Office to update the order status in PrestaShop.

Customizing the payment page
Theme configuration	Allows to customize the payment page by using specific keywords. If you have created several models in the Expert Back Office, enter for example:`RESPONSIVE_MODEL=Model_2`if you want to use the design of your “Model_2”. Warning: Some keywords can only be used if the “Advanced customization” option has been enabled.
Shop name	You can define the name of your shop that will appear in order confirmation e-mails. If the field is empty, the shop name that was registered in the Expert Back Office will be the one to appear in the e-mail.
Shop URL	You can define the shop URL that will appear on the payment page and in the order confirmation e-mail. If the field is empty, the shop URL that was registered in the Expert Back Office will be the one to appear on the payment page and in the e-mail.

Customizing the payment page

Theme configuration

Allows to customize the payment page by using specific keywords.

If you have created several models in the Expert Back Office, enter for example:RESPONSIVE_MODEL=Model_2if you want to use the design of your “Model_2”.

Warning: Some keywords can only be used if the “Advanced customization” option has been enabled.

Shop name

You can define the name of your shop that will appear in order confirmation e-mails.

If the field is empty, the shop name that was registered in the Expert Back Office will be the one to appear in the e-mail.

Shop URL

You can define the shop URL that will appear on the payment page and in the order confirmation e-mail.

If the field is empty, the shop URL that was registered in the Expert Back Office will be the one to appear on the payment page and in the e-mail.

Custom 3DS
Configure 3DS by client group	Allows to request authentication without interaction (frictionless). Requires the optionFrictionless3DS2 For payments made in euro, if the amount is lower than €30, a request for frictionless is transmitted to the DS. If the request for frictionless is accepted by the issuer, the merchant loses the payment guarantee. For payments made in euros, if the amount is greater than €30, the value transmitted by the merchant is ignored and the management of cardholder authentication is delegated to the gateway. For payments made in a currency other than euro, a request for frictionless is transmitted to the DS. This parameter can de configured by user group.

Custom 3DS

Configure 3DS by client group

Allows to request authentication without interaction (frictionless). Requires the optionFrictionless3DS2

For payments made in euro, if the amount is lower than €30, a request for frictionless is transmitted to the DS. If the request for frictionless is accepted by the issuer, the merchant loses the payment guarantee.
For payments made in euros, if the amount is greater than €30, the value transmitted by the merchant is ignored and the management of cardholder authentication is delegated to the gateway.
For payments made in a currency other than euro, a request for frictionless is transmitted to the DS.

This parameter can de configured by user group.

Return to shop
Automatic redirection	This option allows to automatically redirect the buyer to the merchant website. This option depends on the following settings. This option is disabled by default.
Time before redirection (success)	If the automatic redirection option is enabled, you can define the delay in seconds before your buyer is redirected to your shop in case of a successful payment.
Message before redirection (success)	If the automatic redirection option is enabled, you can define the message that will appear on the screen following a successful payment before your buyer is redirected to the shop. The default message is: “Redirection to the shop in a moment”.
Time before redirection (failure)	If the automatic redirection option is enabled, you can define the delay in seconds before your buyer is redirected to your shop in case of a failed payment.
Message before redirection (failure)	If the automatic redirection option is enabled, you can define the message that will appear on the screen following a failed payment before your buyer is redirected to the shop. The default message is: “Redirection to the shop in a moment”.
Return mode	During the redirection to the shop, these parameters are returned to the shop in POST or GET modes. The GET mode is set by default. WARNING: POST mode can cause problems when redirecting to the return page. See the article Redirection problem on return page for more information.
Handling failed payments	Configuration of the module behavior in case of a failed payment: Two options are available: Return to payment method selection (default option), Save the failed order and return to history. In the second case, the order appears in the history with the Payment error or Canceled status.
Shopping cart Management	It is recommended to choose the empty cart option in order to avoid differences in the amount in case the buyer returns to the previous page, edits the shopping cart, and returns to the payment page. In that case, the shopping cart will be emptied, but if the payment is canceled or declined, the shopping cart will be restored. To keep the Prestashop default behavior, select the second option. However, you take the risk of having differences in the amount of some payments.
Customer service messages	Enable or disable the comments added by the payment module in the after-sales service messages. This setting is enabled by default.

Additional options
Send shopping cart details	Select Activate if you wish to send the shopping cart details to the payment gateway. For some payment methods, such as Oney 3x 4x and PayPal, this data is required. In this case, the cart data will be sent anyway, even if the parameter is disabled.
Category association	Associate a type with each category in your catalog. This information is required for Oney 3x 4x payment as well as for risk assessment (the corresponding option must be enabled). You can: • Quickly associate a category with all the products in your catalog • Associate a type with each category in your catalog The categories are: Food and grocery \| Cars \| Entertainment \| Home and gardening \| Household appliances \| Auctions and group purchasing \| Flowers and presents \| Computers and software \| Health and beauty \| Services for individuals \| Services for companies \| Sports \| Clothes and accessories \| Travel \| Home audio, photo, video \| Telephony
Send advanced shipping details	Select “No” if you do not want to send advanced shipping details for each payment (delivery company, type, shipping speed).
Payment method title	The payment module will automatically detect all the available transporters on your website.
Name	Defines the name of a transporter when the field value is not compatible with the Oney payment method. The maximal length is 55 characters. The only authorized special characters are: space, slash, hyphen, apostrophe.
Type	Allows to choose the type of transporter from the following options: Delivery company: Transporters (La Poste, Colissimo, UPS, DHL, etc.) Store pick-up: Item pickup directly from the merchant. Relay point: Use of a network of delivery points (Kiala, Alveol, etc.) Pick-up at a station: Item pickup at an airport, a train station or a travel agency.
Speed	Shipping speed: Express (less than 24h) or standard. Standard Priority (reserved to Click & Collect)
Delay	In case of picking up the item at the shop (Click & Collect) with priority delivery, select the delivery delay from the following options: ≤ 1 hour > 1 hour Immediate 24/7
Address	In case of in-store pickup, populate this field as follows: Address + ZIP Code + City

Module option
Activation	In order to enable the payment method, select Enabled.
Payment method title	This option allows you to define the title of the payment method. The buyer will see this title when choosing a payment method. If your shop is available in several languages, a drop-down list will appear to the right of the method title. Changing the language allows you to enter a different title in each language.

Module option

Activation

In order to enable the payment method, select Enabled.

Payment method title

This option allows you to define the title of the payment method.

The buyer will see this title when choosing a payment method.

If your shop is available in several languages, a drop-down list will appear to the right of the method title. Changing the language allows you to enter a different title in each language.

Restrictions
Supported countries	Configure the countries for which the payment method is available: All countries: the payment method is available for all countries. Specific countries: after choosing this option, the list of Authorized countries appears. Press and hold “`Ctrl`” and select the countries of your choice from the list of Authorized countries.
Minimum amount	This field defines the minimum amount for which you wish to offer this payment method. By defining a minimum amount for ALL GROUPS, the payment method will not be enabled for users with a smaller shopping cart amount. It is also possible to define a minimum amount for each customer group in your shop.
Maximum amount	This field defines the maximum amount for which you do not wish to offer this payment method. By defining a minimum amount for ALL GROUPS, the payment method will not be enabled for users with a greater shopping cart amount. It is also possible to define a maximum amount for each customer group in your shop.

Restrictions

Supported countries

Configure the countries for which the payment method is available:

All countries: the payment method is available for all countries.
Specific countries: after choosing this option, the list of Authorized countries appears. Press and hold “Ctrl” and select the countries of your choice from the list of Authorized countries.

Minimum amount

This field defines the minimum amount for which you wish to offer this payment method.

By defining a minimum amount for ALL GROUPS, the payment method will not be enabled for users with a smaller shopping cart amount.

It is also possible to define a minimum amount for each customer group in your shop.

Maximum amount

This field defines the maximum amount for which you do not wish to offer this payment method.

By defining a minimum amount for ALL GROUPS, the payment method will not be enabled for users with a greater shopping cart amount.

It is also possible to define a maximum amount for each customer group in your shop.

Payment page
Capture delay	Delay (in days) before the capture for this payment method. If you leave this field empty, the value configured in the General configuration section will be applied. If the Capture delay field of the General configuration is also empty, the value configured in the Expert Back Office will be applied.
Validation mode	Validation mode for this payment method. *General configuration of the module:* Recommended value. Allows to apply the configuration defined in the General configuration section. *Back Office configuration:* Allows to use the configuration defined in the Expert Back Office (menu: Settings > Shop > Configuration – section: validation mode) *Automatic:* This value indicates that the payment will be captured in the bank automatically without any action on the merchant’s part. *Manual:* This value indicates that the transactions will require manual validation by the merchant via the Expert Back Office. Warning: if the transaction is not validated by the merchant before the expiration date, it will not be captured in the bank. Remember to configure the Instant Payment Notification rule on an operation coming from the Back Office to update the order status in PrestaShop.
Card types	This field allows to indicate the images used for cards that will be displayed on the payment page or on the merchant website (see “Card data entry”). Warning: The payment types offered to the buyer on the payment page depend on the contracts and options associated with your Lyra Collect offer. It is recommended to select the ALL value.

Payment page

Capture delay

Delay (in days) before the capture for this payment method.

If you leave this field empty, the value configured in the General configuration section will be applied.

If the Capture delay field of the General configuration is also empty, the value configured in the Expert Back Office will be applied.

Validation mode

Validation mode for this payment method.

General configuration of the module: Recommended value.

Allows to apply the configuration defined in the General configuration section.

Back Office configuration:

Allows to use the configuration defined in the Expert Back Office (menu: Settings > Shop > Configuration – section: validation mode)

Automatic:

This value indicates that the payment will be captured in the bank automatically without any action on the merchant’s part.

Manual:

This value indicates that the transactions will require manual validation by the merchant via the Expert Back Office.

Warning: if the transaction is not validated by the merchant before the expiration date, it will not be captured in the bank.

Remember to configure the Instant Payment Notification rule on an operation coming from the Back Office to update the order status in PrestaShop.

Card types

This field allows to indicate the images used for cards that will be displayed on the payment page or on the merchant website (see “Card data entry”).

Warning:

The payment types offered to the buyer on the payment page depend on the contracts and options associated with your Lyra Collect offer.

It is recommended to select the ALL value.

Advanced options
Card data entry mode	This parameter setting is described in the chapter on Choosing the integration type in the documentation.
Canceling payment in iframe mode	By selecting Yes, the buyer will see a cancel button in the iframe to cancel their payment.
Display in a pop-in	Select Yes to display embedded payment fields in a pop-up window.
Theme	Choose the theme you would like to use to display the embedded payment fields.
Compact mode	If your shop offers several payment methods, we recommend that you activate this setting for better legibility. All the payment methods offered by your shop will be compacted.
Threshold for grouping payment methods	From the number entered in this parameter, payment methods will be grouped together.
Display title	If you select No, the Payment by card label will not be displayed unless you offer other payment modules.
Custom fields placeholders	This option will allow you to define the label that will get displayed by default in the embedded payment fields. If your shop supports several languages, you can also define the title of the payment method for each language.
Card registration label	Enter the label that you wish to display for the button Save my card. The Payment by token settings must be enabled to have this text displayed. If your shop is available in several languages, a button will appear on the right of the method title. You can use this button to enter a different title for each language.
Payment attempts number	Maximum number of payment retries after a failed payment, this value must be between 0 and 9. If this value is not specified, the default value will be 3.
Payment by token	The payment by token allows to pay for the order without having to enter the card details upon each payment. During the payment, the buyer decides whether he/she wishes to register his/her card details by ticking the corresponding box available in the payment page. The box will be displayed only if the buyer is connected to the merchant website. This option is disabled by default. WARNING: The ‘payment by token’ option must be enabled in your Lyra shop.
Use the buyer wallet to manage token	An e-wallet allows a buyer to store several payment cards and to choose which one to use when making a purchase, without having to enter the card number. Bank details are stored by the payment gateway, in compliance with the rules imposed by the GDPR (= General Data Protection Regulation). Select Yes to activate the buyer wallet.

Advanced options
Card type selection	The module provides 2 operating modes: On the payment gateway The card type is selected on the Lyra payment page. On the merchant website The card type is chosen when the buyer selects the “Pay by credit card in installments” payment method. The list of available payment methods depends on the configuration of accepted card types (see “Configuration of the card type”).

Advanced options

Card type selection

The module provides 2 operating modes:

On the payment gateway

The card type is selected on the Lyra payment page.

On the merchant website

The card type is chosen when the buyer selects the “Pay by credit card in installments” payment method.

The list of available payment methods depends on the configuration of accepted card types (see “Configuration of the card type”).

Payment options
Payment option	This module allows you to create as many credit card installment payment options as you like. Each payment option will have a different code that will be displayed in the order table. To add a payment option, click on Add. When you are done, remember to save your changes.
Label	Text describing the installment payment option as it will be offered to the buyer. Example: Pay in 3 installments with no fees
Minimum amount	Allows to define the minimum amount required to make the payment option available.
Maximum amount	Allows to define the maximum amount required to make the payment option available.
Merchant ID	The Merchant ID to use with the option, in case your shop has several Merchant IDs. It is recommended to leave this field empty.
Number	Number of installments: 3 for payment in 3 installments 4 for payment in 4 installments etc.
Period	Period (in days) between each installment.
First installment	Amount of the first installment, expressed as a percentage of the total amount. Example: For an amount of EUR 100 in 3 installments, you can set the percentage of the first payment at 50% of the amount. This means that the amount of the first installment will be EUR 50 an that the two others will be of EUR 25. For 50% enter 50. If you want the amount of every installment to be the same, leave this field empty.

Oney payment options
Add	Click the Add button to configure payment options. This configuration is required for the Oney payment method to work.
Label	Enter the label of the option that will be displayed during checkout.
Code	Enter the technical code provided byOney(example: PNF3P).
Payment method	Activate the payment method for your Oney contract: Payment in 3 or 4 installments. Payment in 10 or 12 installments. Pay Later Oney.
Minimum amount	Enter the minimum amount for which this option can be used.
Maximum amount	Enter the maximum amount for which this option can be used.
Number	Enter the number of installments (3 for a payment in 3 installments, etc. ).
Interest rate	Indicate the interest rate applied to the payments. The indicated value is used only for option label customization.

Franfinance payment options
Label	Enter the label of the option that will be displayed during checkout. The default values are: Payment in 3 installments Payment in 4 installments
Number	Enter the number of installments (3 for a payment in 3 installments, etc. ).
Fees	The module provides 3 operating modes: Lyra Back Office configuration: It will use the default settings configured in the Expert Back Office. These values can be viewed and changed via the menu: Settings > Company > Merchant Ids tab. Select your Franfinance contract > Details tab > Default payment option section. No fees: It will force the deactivation of fees for this option. With fees: It will force the activation of fees for this option. WARNING: Make sure you have correctly filled in the corresponding authentication strings in your Franfinance contract, before forcing the application of fees for a payment option.
Minimum amount	Enter the minimum amount for each option.
Maximum amount	Fill the maximum amount for each option.

Full CB payment options
Enable option selection	Select Yes if you wish to force the use of a payment option available with your contractFull CB. This option is set to No by default.
Activation	Check the box to enable the payment method.
Label	Enter the label of the option that will be displayed during checkout. The default values are: Payment in 3 installments Payment in 4 installments
Minimum amount	Enter the minimum amount for each option.
Maximum amount	Fill the maximum amount for each option.
Interest rate	Indicate the interest rate applied to the payments. The default values are: 1.4 for payment in 3 installments. 2.1 for payment in 4 installments.
Fee cap	Indicate the payment option fee limit. Default values: 9 for payment in 3 installments. 12 for payment in 4 installments.

SEPA payment options
SEPA direct debit mode	Select the SEPA direct debit mode: One-off SEPA direct debit: The signed mandate applies to a single direct debit. Register a recurring SEPA mandate with direct debit: The signed mandate allows for a series of direct debits, a payment is created when the mandate is registered. Register a recurring SEPA mandate without direct debit: The signed mandate allows for a series of direct debits, no payments are created when the mandate is registered. This mode is set to One-Off SEPA direct debit by default. The Payment by identifier option must be enabled for your shop if you want to use the second and third cases.

SEPA payment options

SEPA direct debit mode

Select the SEPA direct debit mode:

One-off SEPA direct debit: The signed mandate applies to a single direct debit.
Register a recurring SEPA mandate with direct debit: The signed mandate allows for a series of direct debits, a payment is created when the mandate is registered.
Register a recurring SEPA mandate without direct debit: The signed mandate allows for a series of direct debits, no payments are created when the mandate is registered.

This mode is set to One-Off SEPA direct debit by default.

The Payment by identifier option must be enabled for your shop if you want to use the second and third cases.

Other payment methods
Group payment methods	By enabling this option, all the payment methods added in this section will be displayed within the same payment submodule. Otherwise, each payment method will be represented in a different submodule. This parameter is set to Disabled by default.
Label	Text describing the payment option as it will be offered to the buyer. The label will be displayed only if the Group payment methods option is disabled. Example: Pay via Bancontact If your shop supports several languages, you can also define the label of the payment method for each language.
Payment method	Choose the payment method you would like to offer.
Authorized countries	Select the country that you would like to authorize for the selected payment method. If no countries are selected from the list, all countries will be authorized. Hold down the Ctrl key to select or deselect several countries.
Minimum amount	This field defines the minimum amount for which you wish to offer this payment method.
Maximum amount	This field defines the maximum amount for which you do not wish to offer this payment method.
Capture delay	Delay (in days) before the capture for this payment method. If you leave this field empty, the value configured in the General configuration section will be applied. If the Capture delay field of the General configuration is also empty, the value configured in the Expert Back Office will be applied.
Validation mode	Validation mode for this payment method. *General configuration of the module:* Recommended value. Allows to apply the configuration defined in the General configuration section. *Back Office configuration:* Allows to use the configuration defined in the Expert Back Office (menu: Settings > Shop > Configuration – section: validation mode) *Automatic:* This value indicates that the payment will be captured in the bank automatically without any action on the merchant’s part. *Manual:* This value indicates that the transactions will require manual validation by the merchant via the Expert Back Office. Warning: if the transaction is not validated by the merchant before the expiration date, it will not be captured in the bank. Remember to configure the Instant Payment Notification rule on an operation coming from the Back Office to update the order status in PrestaShop.
Shopping cart data	Check this box if you wish to send the shopping cart details to the payment gateway. For some payment methods, such as Oney 3x 4x and PayPal, the shopping cart details are required.
Add payment methods	If you want to create payment methods that are not present in the Payment methods list, you can add them manually in the payment module: Click the Add button. Enter the technical code provided by Lyra. This code must be exactly the same as the one present in the data dictionary in the Card types (vads_payment_cards) column. If your payment method is not on the list, it is not available in Lyra Enter the name of the payment method to be added. Save your changes. Once the payment method created, you will have to add and configure it from the Payment methods section (previous parameter). The new payment method will be displayed at the end of the Payment methods list.

Categories

Tags

Description of all parameters