General configuration

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

IPN URL of the REST API

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://api.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.

Custom 3DS
Configure 3DS by client group
  • In 3DS1: Disables the 3DS1 process during an e-commerce payment. Requires the Selective 3DS1 option.
    IMPORTANT
    This feature will become obsolete as soon as the 3DS1 version is no longer supported by the networks.

    As of October 2020, issuers can refuse the transaction if 3D Secure authentication has not been performed.

    This behavior is called “Soft Decline”.

    To reduce the number of rejected payments, the payment gateway automatically makes a new payment attempt with 3D Secure authentication, when possible.

  • In 3DS2: Allows to request authentication without interaction (frictionless). Requires the Frictionless 3DS2 option.
    • 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 GET or POST modes.

The GET mode is more convenient for the buyer as it allows to prevent the browser from displaying a pop-up window that indicates that the buyer is leaving an https environment for an http environment which obliges the buyer to click on “Accept” to return to the shop.
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

Once you have completed the configuration, click Save.