Configuring Lyra

To configure the payment module:

Sign into your Dolibarr Back Office.
Go to the Home section, and click on the Configuration menu.
Click on the Modules / Applications sub menu.
Click on the Available app/modules tab.
Configure the module.
Click to access module configuration.

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 signature algorithm is in HMAC-SHA-256. This parameter cannot be modified on the module. 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/

Parameters of the REST API
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).
Public test key	The test public key the test 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).
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.
JavaScript client URL	This field is pre-populated by default: https://api.lyra.com/static/ It is recommended to leave the default value.
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).

Payment page
Default language	This option allows to choose the default language of the payment page in case the language of Dolibarr is not supported by Lyra Collect. If the language(s) used by the Dolibarr is (are) implemented into Lyra Collect, the payment page will be displayed in the language of Dolibarr 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, 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 Dolibarr.

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

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

Advanced options
Card data entry mode	The module provides the following operating modes: Bank data acquisition on the payment gateway Card type selection and data entry is done on the Lyra Collect payment page. Payment fields embedded on the merchant website (REST API) This option enables the integration of embedded payment fields (card number, expiry date, cvv) on your merchant website. The configuration of the REST API keys present in General configuration > REST API keys is mandatory if you enable this functionality. PCI DSS certification is not necessary in this case, however it is strongly recommended for your merchant website to be secure in order to reassure buyers. To use this solution, the merchant must subscribe to the TEST API option (Use of REST API payment). Payment fields embedded in a pop-in (REST API) This option allows to integrate the payment fields (card number, expiry date, cvv) in a pop-in on your merchant website. The configuration of the REST API keys present in General configuration > REST API keys is mandatory if you enable this functionality. PCI DSS certification is not necessary in this case, however it is strongly recommended for your merchant website to be secure in order to reassure buyers. To use this solution, the merchant must subscribe to the TEST API option (Use of REST API payment).

Advanced options

Card data entry mode

The module provides the following operating modes:

Bank data acquisition on the payment gateway

Card type selection and data entry is done on the Lyra Collect payment page.

Payment fields embedded on the merchant website (REST API)

This option enables the integration of embedded payment fields (card number, expiry date, cvv) on your merchant website.

The configuration of the REST API keys present in General configuration > REST API keys is mandatory if you enable this functionality.

PCI DSS certification is not necessary in this case, however it is strongly recommended for your merchant website to be secure in order to reassure buyers.

To use this solution, the merchant must subscribe to the TEST API option (Use of REST API payment).

Payment fields embedded in a pop-in (REST API)

This option allows to integrate the payment fields (card number, expiry date, cvv) in a pop-in on your merchant website.

The configuration of the REST API keys present in General configuration > REST API keys is mandatory if you enable this functionality.

PCI DSS certification is not necessary in this case, however it is strongly recommended for your merchant website to be secure in order to reassure buyers.

To use this solution, the merchant must subscribe to the TEST API option (Use of REST API payment).

Dolibarr settings
Bank account	Default bank account to record the payments performed. The Banks and Cash module must be enabled. This parameter is not managed by out module but directly by Dolibarr.

Once you have completed the configuration, click Save.

Categories

Tags

Configuring Lyra