Parameter description

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.

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.osb.pf/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).
REST API server URL	This field is pre-populated by default: https://api.secure.osb.pf/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 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).
JavaScript client URL	This field is pre-populated by default: https://static.osb.pf/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 by OSB. If the language(s) used by the Magento is (are) implemented into PayZen by OSB, 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.

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.

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
Managing 3DS	Allows to request authentication without interaction (frictionless). Requires the Frictionless 3DS2 option.

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 POST mode is set by default.
Order status	Select the Registered orders status. It is recommended to leave the default value.
Creating an invoice	Select Yes to create an invoice for each payment.

Additional options
Send shopping cart details	Select Activate if you wish to send the shopping cart details to the payment gateway.
Category association	Associate a type with each category in your catalog. This parameter is required to perform fraud verification (subject to the option). 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
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
Online transaction currency	Currency used for processing PayZen payment transactions, 2 settings are possible: Display currency: currency of shop view or currency displayed to buyer. Base currency: base currency configured on Magento.

Module option
Activation	Select the Enabled option to activate the payment method.
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.
Order	If you offer several payment methods, enter a number in the Sort order field to determine the position of this payment method. The payment methods appear in ascending order according to the Sort order value.
Logo	Click the Browse button to access your hard drive and thus select the logo of your choice to modify it. The buyer will see this logo when choosing a payment method.

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 Merchant 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 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, 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 Magento.
Card types	Select the payment methods you want to display on the payment page. Hold down the Ctrl key if you want to select multiple payment methods. The payment types offered to the buyer on the payment page depend on the contracts and options associated with your OSB offer. It is recommended to select the ALL value to display all payment methods compatible with 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 Merchant 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 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, 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 Magento.

Card types

Select the payment methods you want to display on the payment page.

Hold down the Ctrl key if you want to select multiple payment methods.

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

It is recommended to select the ALL value to display all payment methods compatible with your shop.

Advanced options
Card data entry mode	This parameter setting is described in the chapter on Choosing the integration type in the documentation.
Display mode	Select the display mode of your choice: Directly on the merchant website: To display the payment areas directly via your merchant website. In a pop-in window: Display the payment fields in a window that will appear on top of your merchant website.
Theme	Choose the theme you would like to use to display the embedded payment fields.
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.
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.
Always update the order status	By enabling this option, the order status will be updated for each payment attempt.
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. The payment by token option must be enabled in your OSB shop.

Advanced options for payment in installments
Card type selection	The module provides 2 operating modes: On the payment gateway The card type is selected on the OSB 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 for payment in installments

Card type selection

The module provides 2 operating modes:

On the payment gateway

The card type is selected on the OSB 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”).

Multi payment option
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 10 000 XPF 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 5 000 XPF an that the two others will be of 2 500 XPF. For 50% enter 50. If you want the amount of every installment to be the same, leave this field empty.

Payment options for 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.
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.
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.
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 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, 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 Magento.
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 Merchant Back Office will be applied.
Integrated mode	Check this box if you would like to use this payment method with the embedded payment (see chapter Choosing the integration type). Click on this link to see the payment methods compatible with the embedded payment.
Shopping cart data	Check this box if you wish to send the shopping cart details to the payment gateway.
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 OSB. 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 OSB 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

Parameter description