Difference between revisions of "XP Cloud:General Settings"

From X-Payments Help
Jump to: navigation, search
m
m
 
(20 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
__NOTOC__<br>
 
__NOTOC__<br>
  
−
X-Payments Cloud general settings can be found on the 'General settings' page (Settings -> General settings). This page is available from both the X-Payments Cloud standalone admin panel:
+
X-Payments Cloud general settings can be found on the General settings page ('''Settings''' -> '''General'''). This page is available from both the X-Payments Cloud standalone admin panel:
−
: [[File:xpc_general_settings_link1.png | 740px | border]]<br />
+
: [[File:xpc_general_settings_link_s.png | 670px | border]]<br />
−
and the X-Payments Cloud admin panel as accessed from within the admin back end of your online store:
+
and the X-Payments Cloud admin panel as accessed from within the admin panel of your online store:
−
: [[File:xpc_general_settings_link.png | 740px | border]]<br />
+
: [[File:xpc_general_settings_link.png | 670px | border]]<br />(The screenshot above shows the way to access the General settings page from the X-Cart 5 admin panel. On other platforms, you will find a similar menu, but please expect that the page layout may be different.)
−
The page itself looks as follows:
+
The General settings page itself looks as follows:
−
: [[File:xpc_general_settings.png | 740px | border]]<br />
+
: [[File:xpc2021_general_settings.png | 670px | border]]<br /><br />
−
Before you start using X-Payments Cloud to accept payments, be sure to review the settings on this page and adjust them as you require. Be sure to click the '''Save''' button at the bottom of the page to save your changes.
+
Before you start using X-Payments Cloud to accept payments, take time to review the settings on this page, and adjust them as you require. Be sure to click the '''Save''' button at the bottom of the page to save your changes.
  
 
Below you will find an explanation of what each setting is used for.
 
Below you will find an explanation of what each setting is used for.
  
−
===General settings===
+
===Configuration===
−
: [[File:XP_general_settings.png|border]]
+
In this section, the only setting is '''Current time and date'''.
 +
: [[File:xpc_general_settings_configuration.png| 670px | border]]
  
−
* '''Current time and date''': Specify the current time and date (This is needed so X-Payments can record the time and date of payments correctly).
+
Use it to specify the current time and date in your time zone. That is needed so X-Payments Cloud can record the time and date of payments correctly.
  
−
* '''User account password lifetime (days)''': This setting applies to all X-Payments users except for the root administrator; it ensures that X-Payments users will regularly change their account passwords. Here you must enter the number of days that user account passwords will be valid for. Users will be supposed to change their account password before the period defined by this setting expires for their account; otherwise, the account will be locked, after which only the X-Payments root administrator will be able to unlock it. It is possible to enable email notifications for users whose account is about to be locked due to password expiration (See the 'Account is locked due to password expiration' setting in 'General settings/Email Notifications').
+
===Connection Key===
−
 
 
−
* '''Dangerous activity blocking period (minutes)''': Repeated failed login attempts by a user are identified by X-Payments as dangerous activity, which causes the user account to be temporarily locked. Here you must specify the period (in minutes) for which the user account locked for dangerous activity must remain in the locked status. X-Payments root admin can unlock the user at any time before the end of the dangerous activity blocking period.
 
−
 
 
−
{{Note1|If the admin account is blocked due to repeated access attempts, he or she needs to wait until the specified dangerous activity blocking period passes and then try to sign in again.}}
 
−
 
 
−
* '''Show errors on the Dashboard page for the last X days''': Specify the number of days for which you want transaction errors to be displayed on the Dashboard.
 
−
 
 
−
* '''Remove log files after X days''': Specify how long X-Payments log files should be stored before removal. Note that according to PCI DSS requirements log files must be stored for at least 90 days.
 
−
 
 
−
===Payments===
 
−
This section contains settings pertaining to the payment process.
 
−
:[[File:XP_payments_settings.png|border]]
 
−
 
 
−
* '''Maximum allowed payment attempts''': This setting is available in X-Payments versions 3.1.2 and later. It enables you to set a limit on the number of payment card information entry attempts that should be available to a user within a single payment session. This feature is aimed at preventing fraudsters from using other people's payment information by guessing it and making repetitive attempts to submit it as their own. The number specified in this field will be treated as the number of attempts a user should be given to submit their payment information to the payment gateway. For example, if you set this number to "1", users will be able to submit their payment information just once per payment session. If the payment attempt fails (for example, because the payment information being used is incorrect), the order will be declined. Or, for example, if this number is set to "3", and a user's first payment attempt is rejected by the payment gateway, the user will be able to update their payment information and try again two more times. After all the payment attempts - as allowed by this setting - have been used, the user's order will be declined.
 
 
   
 
   
−
* '''Display "Save card" option enabled by default''': When a payment configuration with tokenization support is used for payment, a checkbox option to save the credit card ("I want to use this credit card for my future orders in this shop") is provided below the credit card entry form. The setting "Display "Save card" option enabled by default" enables you to set the default state of that checkbox.
+
This section is only available in the X-Payments Cloud standalone admin panel (not visible when the settings page is accessed from within the admin panel of your online store). It shows the date on which the current connection key was generated. It also provides the '''View connection key''' link for access to the Connection Key page in the X-Payments Cloud admin panel.  
−
 
 
−
===Cardholder Data===
 
−
 
 
−
: [[File:XP_cardholderdata_settings.png|border]]
 
−
 
 
−
The setting in this section controls the storage of cardholder data.
 
  
−
* '''Retention period (days)''': Specify the number of days that the collected cardholder data is to be retained. Removal of stored cardholder data occurs as a result of [[X-Payments:Installation#Running_the_cron.php_script|running the cron.php script]]. When this script is run, a check is conducted to determine whether it is already time to remove the stored cardholder data. Then all instances of cardholder data that have been stored for the number of days defined by the "Retention period (days)" setting or longer are removed. If the "Retention period (days)" setting is set to "0" (zero), the data is removed at the first run of cron.php after the data has been collected.
+
:[[File:xpc_connection_key_section.png | 670px | border]]
  
−
===Email Notifications===
+
On the Connection Key page, you can preview and copy your current connection key.
 +
:[[File:xpc_connection_key_page.png | 670px | border]]
  
−
These settings control to whom and when event notifications are sent.
+
A connection key is a bundle that contains the following components:
 +
* API key (the key used to make API requests),
 +
* Secret key (the key used to validate API requests),
 +
* Widget key (the key used to display the payment form widget in the process of checkout).
  
−
: [[File:XP2.0_email_notifs_gensettings.png|border]]
 
  
−
* '''User management notifications email''': Enter the email address for notifications about events related to user accounts (like creation, modification and deletion of user profiles). Specific types of notifications that need to be sent to this address can be selected in the 'More event notifications' section below.
+
===Services===
  
−
* '''Payment processing notifications email''': Enter the email address for notifications about payment transactions.
+
This section is where you can configure and enable [[XP_Cloud:Services | services]].
 +
: [[File:xpc_services_section.png | 670 px | border]]
  
−
* '''General notifications email''': Enter the email address for notifications about various events that may happen during the operation of X-Payments (unauthorized access attempts, errors, etc).
+
===Processing===
  
−
'''Inform users about the following events:'''
+
:[[File:xpc_general_settings_processing.png | 670 px | border]]
  
−
* '''Account is locked due to password expiration''': Select this option if you want non-root X-Payments users to be notified by email when their account password is about to expire (related to the 'User account password lifetime (days)' setting in the 'General settings' section). Specify how many days before password expiration the notification is to be sent.
+
This section contains the following settings:
  
−
* '''Account expires''': Select this option if you want non-root X-Payments users to be notified by email when their account is about to expire (related to the 'Expiration date' setting in the user's account details). Specify how many days before account expiration the notification is to be sent.
+
:* '''Transaction amount for card tokenization''': An amount for which a transaction needs to be created during a card tokenization process for gateways that do not support "zero-dollar" authorizations. This transaction will be voided automatically.
  
−
* '''Account is locked due to user inactivity''': Select this option if you want non-root X-Payments users to be notified by email when their account is about to be locked due to user inactivity (related to the 'Inactivity period' setting in the user's account details). Specify how many days before the account is locked the notification is to be sent.
+
:* '''Detect Cloudflare client IP address''': A proxy related setting. The idea behind this setting is that if your store server uses Cloudflare, it may interfere with the work of X-Payments Cloud. You may want to enable this setting to resolve the IP address-related issues that may arise if using Cloudflare.
  
−
'''More event notifications''':
+
===Subscriptions===
  
−
Click the 'More event notifications' link to open the detailed event notifications section. Here you can specify the types of email notifications that will be sent to X-Payments users and the owner of the User management notifications email address (typically, administrator).
+
:[[File:xpc_general_settings_subscriptions.png | 670 px | border]]
  
−
: [[File:XP2.0_event_notifs_gensettings.png|border]]
+
This section contains the following settings:
  
−
Use the checkboxes in the 'User account email' column to select notifications for owners of X-Payments user accounts, the checkboxes in the 'User management email' column - notifications for owner of the User management notifications email address.
+
:* '''Number of rebill attempts for an unsuccessful charge''': The maximum number of times that X-Payments must try to charge the customer's card after the initial attempt to process the subscription payment was unsuccessful. After this number of additional attempts, X-Payments will stop the subscription and send an email notification message to the X-Payments administrator.
  
−
===Proxy===
+
:* '''How often to attempt rebills for an unsuccessful charge (in days)''': How often X-Payments must attempt to charge the card again if the initial attempt to process the subscription payment was unsuccessful. For example, if you set this value to "3", X-Payments will attempt to charge the customer's card once every three days - until the payment can be processed successfully, or the maximum number of rebill attempts is reached.
−
This section allows you to manage your proxy related settings.
 
  
−
:[[File:XP_cloudflare_settings.png|border]]
+
:* '''Notify the customer of the upcoming payment X days in advance''': X-Payments can notify subscription customers that they are going to be charged for their subscription soon - a few days before the subscription payment is actually billed to their account. This setting allows you to specify how many days in advance X-Payments must send a notification message about the upcoming subscription payment to customers with active subscriptions.
  
−
* '''Enable Cloudflare support''': If your store server uses Cloudflare, it may interfere with the work of X-Payments. You may want to enable this option to resolve the IP address related issues that may arise if using Cloudflare.
+
[[Category:X-Payments Cloud User Manual]]

Latest revision as of 04:07, 1 October 2021

X-Payments Cloud User Manual
  1. X-Payments Cloud: General information
  2. Get Started with X-Payments Cloud
  3. Two-factor User Authentication
  4. General Settings
  5. Payment Configurations
  6. Services
  7. Users
  8. User Interface
  9. Payments
  10. Supported Payment Gateways
  11. What's New in X-Payments Cloud


X-Payments Cloud general settings can be found on the General settings page (Settings -> General). This page is available from both the X-Payments Cloud standalone admin panel:

Xpc general settings link s.png

and the X-Payments Cloud admin panel as accessed from within the admin panel of your online store:

Xpc general settings link.png
(The screenshot above shows the way to access the General settings page from the X-Cart 5 admin panel. On other platforms, you will find a similar menu, but please expect that the page layout may be different.)

The General settings page itself looks as follows:

Xpc2021 general settings.png

Before you start using X-Payments Cloud to accept payments, take time to review the settings on this page, and adjust them as you require. Be sure to click the Save button at the bottom of the page to save your changes.

Below you will find an explanation of what each setting is used for.

Configuration

In this section, the only setting is Current time and date.

Xpc general settings configuration.png

Use it to specify the current time and date in your time zone. That is needed so X-Payments Cloud can record the time and date of payments correctly.

Connection Key

This section is only available in the X-Payments Cloud standalone admin panel (not visible when the settings page is accessed from within the admin panel of your online store). It shows the date on which the current connection key was generated. It also provides the View connection key link for access to the Connection Key page in the X-Payments Cloud admin panel.

Xpc connection key section.png

On the Connection Key page, you can preview and copy your current connection key.

Xpc connection key page.png

A connection key is a bundle that contains the following components:

  • API key (the key used to make API requests),
  • Secret key (the key used to validate API requests),
  • Widget key (the key used to display the payment form widget in the process of checkout).


Services

This section is where you can configure and enable services.

Xpc services section.png

Processing

Xpc general settings processing.png

This section contains the following settings:

  • Transaction amount for card tokenization: An amount for which a transaction needs to be created during a card tokenization process for gateways that do not support "zero-dollar" authorizations. This transaction will be voided automatically.
  • Detect Cloudflare client IP address: A proxy related setting. The idea behind this setting is that if your store server uses Cloudflare, it may interfere with the work of X-Payments Cloud. You may want to enable this setting to resolve the IP address-related issues that may arise if using Cloudflare.

Subscriptions

Xpc general settings subscriptions.png

This section contains the following settings:

  • Number of rebill attempts for an unsuccessful charge: The maximum number of times that X-Payments must try to charge the customer's card after the initial attempt to process the subscription payment was unsuccessful. After this number of additional attempts, X-Payments will stop the subscription and send an email notification message to the X-Payments administrator.
  • How often to attempt rebills for an unsuccessful charge (in days): How often X-Payments must attempt to charge the card again if the initial attempt to process the subscription payment was unsuccessful. For example, if you set this value to "3", X-Payments will attempt to charge the customer's card once every three days - until the payment can be processed successfully, or the maximum number of rebill attempts is reached.
  • Notify the customer of the upcoming payment X days in advance: X-Payments can notify subscription customers that they are going to be charged for their subscription soon - a few days before the subscription payment is actually billed to their account. This setting allows you to specify how many days in advance X-Payments must send a notification message about the upcoming subscription payment to customers with active subscriptions.
Retrieved from "https://www.x-payments.com/help/?title=XP_Cloud:General_Settings&oldid=2835"