• France
status page
Demo shops
assistance
FAQContact support
Search
Categories
Tags
Europe (English)
France
Spain
Europe (English)
India
Homepage
Use cases
Create a payment
Create an installment payment
Create a multi-card (split) payment
Create a payment by Alias (Token)
Create a payment link
Create a recurring payment
Manage subscriptions
Manage your transactions (refund, cancel...)
Analyze your reports
API docs
Embedded Form
REST API
Hosted payment
Mobile payment
File exchange
SDD mandates by REST API
Snippets
Payment methods
Plugins
Marketplace
Guides
Merchant Back Office
Back Office Expert
Functional guides

Configuring the payment module

To configure the payment module:

  1. Go to the configuration > method of payment menu of the xtCommerce Back Office.
  2. Search for the Pay with Lyra payment method, then the box in the selection column.
  3. Click enable selection, then click Yes to confirm.
  4. Click on the edit button of the Pay with Lyra payment method.
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).

Payment page URL

This field is pre-populated by default: https://secure.lyra.com/vads-payment/

Payment page
Default language

This option allows to choose the default language of the payment page in case the language of xtCommerce is not supported by Lyra Collect.

If the language(s) used by the xtCommerce is (are) implemented into Lyra Collect, the payment page will be displayed in the language of xtCommerce when the buyer clicks on “Pay”.
Available languages

Allows to customize the language displayed on the payment page.

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, 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 xtCommerce.

Card types

This field allows to select the cards logo to be displayed on the payment page.

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 leave this parameter empty.
Selective 3DS
Disable 3DS

Amount below which 3DS will be disabled.

Below this amount, 3DS risk assessment rules will not be applied. Leave empty to use the payment gateway configuration.

WARNING:

The value of this field will be taken into account only if the option “Selective 3D-Secure” is enabled for your Lyra Collect shop.

This option can only be enabled upon agreement of your bank.

Some card types, such as MAESTRO, require a mandatory 3DS authentication. In this case, your configuration will not be taken into account.

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) In case 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)

In case the automatic redirection option is enabled, you can define the message that will appear on the gateway 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) In case 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)

In case the automatic redirection option is enabled, you can define the message that will appear on the gateway 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.
New order status

Choose the order status from the list before the payment gets finalized.

Order status in case of success

Select the order status from the list of accepted payment statuses.

Order status in case of failure

Choose the order status from the list of declined payment statuses.

Standard payment
Activation

Check the box to enable standard payment.

This mode est set to Enabled by default.

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 button will appear on the right of the method title. You can use this button to enter a different title for each language.

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 beyond which you do not wish to offer this payment method.
Payment in installments
Activation

Check the box to enable installment payment.

By default, this method is Disabled.

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 button will appear on the right of the method title. You can use this button to enter a different title for each language.

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 beyond which you do not wish to offer this payment method.
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.

Once you have completed the configuration, do not forget to click Save in order 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 100 EUR 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 amount to 50 EUR an that the two

others will be of 25 EUR.

For 50% enter 50.

If you want the amount of every installment to be the same, leave this field empty.

Once you have completed the configuration, click Save.

Jobs
Legal
GDPR
25.20-1.11