Description of all parameters
| Access to the payment gateway | |
|---|---|
| Module status | Select Enable to enable the payment module. |
| 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. |
| Payment area | Define the payment area to which this payment method will apply. The None value means that the module applies to all areas. |
| 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. |
| Payment page URL | This field is pre-populated by default: https://secure.osb.pf/vads-payment/ |
| 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. |
| 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). |
| IPN URL of the REST API | 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). |
| 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. |
| JavaScript client URL | This field is pre-populated by default: It is recommended to leave the default value. |
| Advanced options | |
|---|---|
| Card data entry mode | This parameter setting is described in the chapter on Choosing the integration type in the documentation. |
| Display in a pop-in | Select Enabled to display embedded payment fields in a pop-up window. |
| Theme | Choose the theme you would like to use to display the embedded payment fields. |
| Compact mode | If your shop offers several payment methods, we recommend that you activate this setting for better legibility. All the payment methods offered by your shop will be compacted. |
| Threshold for grouping payment methods | From the number entered in this parameter, payment methods will be grouped together. |
| 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. |
| Payment page | |
|---|---|
| Default language | This option allows to choose the default language of the payment page in case the language of osCommerce is not supported by PayZen by OSB. If the language(s) used by the osCommerce is (are) implemented into PayZen by OSB, the payment page will be displayed in the language of osCommerce 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 osCommerce. |
| 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 PayZen by OSB offer. It is recommended to leave this parameter empty. |
| Custom 3DS | |
|---|---|
| Managing 3DS | Allows to request authentication without interaction (frictionless). Requires the Frictionless 3DS2 option. |
| Restrictions | |
|---|---|
| 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. |
| Payment options | |
|---|---|
| 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. |
| 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 | This option allows to define the status of an order successfully paid using this payment mode. |
To finish the configuration, click Save