General configuration
| Basic settings | |
|---|---|
| Logs | Allows to enable or disable module logs. The logs will be available in the /var/log directory on the server. This parameter is enabled by default. |
| Access to the payment gateway | |
|---|---|
| Shop ID | Indicate the 8-digit shop ID, available in your Merchant Back Office (Menu: Settings > Shop > Keys). |
| Test key | Specify the test key available via your Merchant Back Office (Menu: Settings > Shop > Keys). |
| Production key | Specify the production key available in your Merchant Back Office (Menu: Settings > Shop > Keys). Note that the production key will only become available after the test phase has been completed. |
| 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 Merchant Back Office (Settings > Shop > Keys). If the algorithm is different, the parameter will have to be modified via the Merchant Back Office. |
| Instant Payment Notification URL | URL to copy in your Merchant 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.payzen.eu/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 Merchant 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 Merchant Back Office (Menu: Settings > Shops > REST API keys). |
| 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 Merchant 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 Merchant 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 Merchant 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 Merchant Back Office (Menu: Settings > Shops > REST API keys). |
| IPN URL of the REST API | This field is pre-populated by default: https://api.payzen.eu/api-payment/ It is recommended to leave the default value. |
| JavaScript client URL | This field is pre-populated by default: https://static.payzen.eu/static/ It is recommended to leave the default value. |
| REST API Instant Payment Notification URL | URL to copy in your Merchant 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. |
| Payment page | |
|---|---|
| Default language | This option allows to choose the default language of the payment page in case the language of Magento is not supported by PayZen. If the language(s) used by the Magento is (are) implemented into PayZen, the payment page will be displayed in the language of Magento 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 Merchant 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 Merchant 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 Merchant 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 Magento. |
| Customizing the payment page | |
|---|---|
| Theme configuration | Allows to customize the payment page by using specific keywords. If you have created several models in the Merchant 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 Merchant 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 Merchant 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 Frictionless 3DS2 option.
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”. |
| Status of recorded orders | Select the status of successfully paid orders.
|
| Creating an invoice | Select Yes if you wish to automatically create an invoice when the payment is successful and the order has the “Processing” status. |
| Additional options | |
|---|---|
| Send shopping cart details | Select Yes if you wish to send the shopping cart details to the payment gateway. For some payment methods, such as and PayPal, the shopping cart details are required. |
| Category association | Associate a type with each category in your catalog. This information is required 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 |
| Payment method title | The payment module will automatically detect all the available transporters on your website. |
| Last 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 |
Once you have completed the configuration, click Save.
