Difference between revisions of "X-Payments:Managing store connections"

From X-Payments Help
Jump to: navigation, search
m (→‎Adding an Online Store)
m
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>{{XP_manual_TOC}}</noinclude>
 
<noinclude>{{XP_manual_TOC}}</noinclude>
  
−
X-Payments needs to be provided with information about the online stores that you wish to use with it. This can be done via the 'Online Stores' page (Settings -> Online stores) in the X-Payments back end. Here you can add new stores, enable/disable existing stores, view/edit the stores' details and delete the stores you no longer wish to use with X-Payments.
+
X-Payments needs to be provided with information about the online store(s) that you wish to use with it. This can be done via the 'Online Stores' page (Settings -> Online stores) in the X-Payments back end.  
 +
:[[File:XP_onlinestore.png|border|700px]]
  
−
====Adding an Online Store====
+
On X-Payments plans supporting a '''single online shop integration''', this section looks like the following:
 +
:[[File:xp_mystore.png|border|700px]]
  
−
To start using a new store with X-Payments, you must add this store to the list of your online stores in the X-Payments back end.  
+
To specify your store details, you will need to adjust the following field values:
 +
* '''Store name:''' Enter a short name by which this online store will be identified in X-Payments. This name will be used on the 'Payment Configurations' and 'Payments' pages.
 +
* '''Store title:''' Enter your store title as you want your customers to see it. The title will appear in the browser tab header to customers using a credit card form shown on a separate page; note that it will not be displayed anywhere if you choose to use a credit card form displayed via iframe (not on a separate page).
 +
* '''Order prefix:''' Enter a prefix that will help you to distinguish orders from this online store from other orders in the payment gateway backoffice. The value entered into this field will be used as part of Reference ID for transactions originating at this store.<br />{{Note1|Note: A full transaction Reference ID consists of the online store prefix, the payment configuration prefix and the reference ID (for example, the order ID).}}
 +
* '''Template:''' Specify the payment form template that should be used for the page where the customers of this online store will enter payment information. For instructions on how to edit payment form templates, see the following articles:
 +
** [[X-Payments:Customizing_the_interface_(X-Payments_3)|X-Payments:Customizing the interface (X-Payments_3)]]
 +
** [[X-Payments:Customizing_the_interface_(X-Payments_2.2_and_earlier)|X-Payments:Customizing the interface (X-Payments 2.2 and earlier)]]
 +
After making changes, be sure to click '''Save'''.
  
−
To add a new store:
+
Once your store details have been specified, you can proceed to connecting your online store to X-Payments. Here we have some X-Payments connection manuals:<br />
−
# In the X-Payments back end, go to the 'Online Stores' page (Settings -> Online stores).
+
{{XP_connector_manuals}}
−
# Click the '''Add new''' button. The 'Add new online store' section opens.<br />X-Payments 3.0:<br />[[File:Xp3_add_online_store.png|border]]<br />X-Payments 2.0:<br />[[File:XP2.0_add_store.png|border]]
 
−
# Complete the following fields:
 
−
#* '''Store name:''' Enter a short name by which this online store will be identified in X-Payments. This name will be used on the 'Payment Configurations' and 'Payments' pages.
 
−
#* '''Order prefix:''' Enter a prefix that will help you to distinguish orders from this online store from other orders in the payment gateway backoffice. The value entered into this field will be used as part of Reference ID for transactions originating at this store.<br />{{Note1|Note: A full transaction Reference ID consists of the online store prefix, the payment configuration prefix and the reference ID (for example, the order ID).}}
 
−
#* '''Template:''' Specify the template that should be used for the page where the customers of this online store will enter payment information.
 
−
#* '''Payment configurations:''' If you have already set up the payment configurations that should be available for orders in this online store, assign them to this store by selecting the respective check boxes. If the required payment configurations have not yet been set up, just leave this field as is - you will be able to save the new store without a payment configuration assigned (the store will be marked 'Not configured'); just be sure to assign a payment configuration before connecting the store to X-Payments.
 
−
# Click '''Save'''. The online store is created.<br />After you have clicked '''Save''', the page will refresh and you will see the 'Online Store Details' page with the details of the online store you have just added. You can use this page to edit the information you have provided at the previous step and/or obtain the information needed to connect the store in question with X-Payments (i.e. the configuration bundle, store ID and encryption keys; see the instructions for connecting your specific type of online store for more information). Note that when you first add a store in X-Payments, it is added with the ''Disabled'' status; before you can get paid by the customers of this store via X-Payments you will need to enable it.
 
  
−
====Connecting an Online store====
+
In '''X-Payments Multistore''' the 'Online Stores' page has more controls allowing you to add and manage multiple stores. You must add all the stores you are going to use with X-Payments to the list of your X-Payments online stores. You will then be able to enable/disable existing stores, view/edit the stores' details and delete the stores you no longer wish to use. See below for instructions on the management of online store connections in X-Payments Multistore:
  
−
{{XP_connector_manuals}}
+
====Adding an Online store====
 +
To add a new store:
 +
# On the 'Online Stores' page (Settings -> Online stores), click '''Add new'''. The 'Add new online store' section opens.<br />X-Payments 3.0:<br />[[File:Xp3_add_online_store.png|668px|border]]<br />X-Payments 2.0:<br />[[File:XP2.0_add_store.png|border]]
 +
# Provide the general information about your store (Store name, Store title, Order prefix, Template) and specify the payment configurations you want to use with it.
 +
# Click '''Save'''.<br />
 +
The online store will be created. Once this happens, the page will refresh and you will see the 'Online Store Details' page with the details of the online store you have just added. You can use this page to edit the information you have provided at the previous step and/or obtain the information needed to connect the store in question to X-Payments (i.e. the configuration bundle, store ID and encryption keys; see the instructions for connecting your specific type of online store for more information). Note that when you first add a store in X-Payments, it is added with the ''Disabled'' status; before you can get paid by the customers of this store via X-Payments you will need to enable it.
  
 
====Online Stores List====
 
====Online Stores List====
 +
 
Online stores added to X-Payments can be viewed and managed on the 'Online Stores' page (Settings -> Online stores). On this page you can see your online stores as a list:
 
Online stores added to X-Payments can be viewed and managed on the 'Online Stores' page (Settings -> Online stores). On this page you can see your online stores as a list:
 
: [[File:XP2.0_online_stores.png|border]]
 
: [[File:XP2.0_online_stores.png|border]]
Line 33: Line 41:
  
 
====Viewing an Online Store's Details====
 
====Viewing an Online Store's Details====
−
 
 
To view the details of a specific store, click on its name in the list. The 'Online store details' page opens showing all the information related to the store:
 
To view the details of a specific store, click on its name in the list. The 'Online store details' page opens showing all the information related to the store:
  

Latest revision as of 00:40, 2 March 2022

X-Payments user manual
  1. X-Payments:General information
  2. What's New
  3. System requirements
  4. Installation
  5. Two-factor user authentication
  6. Configuring X-Payments
  7. Managing users
  8. Customizing the interface
  9. Managing payments
  10. Unistalling X-Payments
  11. Upgrading
  12. Moving X-Payments from one host to another
  13. Viewing X-Payments logs
  14. FAQ
  15. Troubleshooting
  16. Glossary
  17. Supported payment gateways
  18. Popular Payment Methods Configuration Instructions

X-Payments needs to be provided with information about the online store(s) that you wish to use with it. This can be done via the 'Online Stores' page (Settings -> Online stores) in the X-Payments back end.

XP onlinestore.png

On X-Payments plans supporting a single online shop integration, this section looks like the following:

Xp mystore.png

To specify your store details, you will need to adjust the following field values:

  • Store name: Enter a short name by which this online store will be identified in X-Payments. This name will be used on the 'Payment Configurations' and 'Payments' pages.
  • Store title: Enter your store title as you want your customers to see it. The title will appear in the browser tab header to customers using a credit card form shown on a separate page; note that it will not be displayed anywhere if you choose to use a credit card form displayed via iframe (not on a separate page).
  • Order prefix: Enter a prefix that will help you to distinguish orders from this online store from other orders in the payment gateway backoffice. The value entered into this field will be used as part of Reference ID for transactions originating at this store.
    Note: A full transaction Reference ID consists of the online store prefix, the payment configuration prefix and the reference ID (for example, the order ID).
  • Template: Specify the payment form template that should be used for the page where the customers of this online store will enter payment information. For instructions on how to edit payment form templates, see the following articles:

After making changes, be sure to click Save.

Once your store details have been specified, you can proceed to connecting your online store to X-Payments. Here we have some X-Payments connection manuals:
X-Payments Cloud

X-Payments v1.x-3.x

In X-Payments Multistore the 'Online Stores' page has more controls allowing you to add and manage multiple stores. You must add all the stores you are going to use with X-Payments to the list of your X-Payments online stores. You will then be able to enable/disable existing stores, view/edit the stores' details and delete the stores you no longer wish to use. See below for instructions on the management of online store connections in X-Payments Multistore:

Adding an Online store

To add a new store:

  1. On the 'Online Stores' page (Settings -> Online stores), click Add new. The 'Add new online store' section opens.
    X-Payments 3.0:
    Xp3 add online store.png
    X-Payments 2.0:
    XP2.0 add store.png
  2. Provide the general information about your store (Store name, Store title, Order prefix, Template) and specify the payment configurations you want to use with it.
  3. Click Save.

The online store will be created. Once this happens, the page will refresh and you will see the 'Online Store Details' page with the details of the online store you have just added. You can use this page to edit the information you have provided at the previous step and/or obtain the information needed to connect the store in question to X-Payments (i.e. the configuration bundle, store ID and encryption keys; see the instructions for connecting your specific type of online store for more information). Note that when you first add a store in X-Payments, it is added with the Disabled status; before you can get paid by the customers of this store via X-Payments you will need to enable it.

Online Stores List

Online stores added to X-Payments can be viewed and managed on the 'Online Stores' page (Settings -> Online stores). On this page you can see your online stores as a list:

XP2.0 online stores.png

For each store on the list you can see its current status: Enabled or Disabled; stores that have been saved without a payment configuration assigned are marked Not configured (This can be corrected by editing the store's details).

On this page you can:

  • Open the details of a specific store for viewing/editing;
  • Enable/disable stores;
  • Delete stores.

Viewing an Online Store's Details

To view the details of a specific store, click on its name in the list. The 'Online store details' page opens showing all the information related to the store:

X-Payments 3.0:

Xp3 store details.png

X-Payments 2.0:

XP2.0 example store details.png

On this page you can:

  • View/edit the store's details;
  • Enable/disable the store;
  • Delete the store.

Note the following important pieces of information that can be obtained on this page:

  • Encryption Keys: These are used to ensure the security of communication between your store and X-Payments.
    The standard set of encryption keys for each store includes the following:
    - the public key used to encrypt data sent to X-Payments from the store;
    - the private key used to decrypt data sent from X-Payments to the store;
    - the private key password used to decrypt the private key.
    To view or re-generate the store's encryption keys, use the View online store encryption keys link at the top of the 'Online Store Details' page.
  • Store ID and Configuration bundle: These values are generated automatically when you add a new store to X-Payments. They are needed to poperly connect X-Payments to your store. The store ID allows X-Payments to correctly identify requests coming from your store. The configuration bundle is a string that contains a set of X-Payments connection settings.

Enabling/Disabling an Online Store

To enable/disable an online store, do one of the following::

  • On the 'Online Stores' page:
    X-Payments 2.0 and later: Click the button dropdown element opposite the store name and select the required action (Enable / Disable) from the menu:
    XP2.0 disable delete l.png
    X-Payments 1.0: Click the [ enable ] / [ disable ] link opposite the store name:
    XP1.0 disable enable l.png
  • On the 'Online store details' page:
    X-Payments 2.0 and later: Click the button dropdown element near the 'Store name' field or at the bottom of the page and select the required action (Enable (and save)/Disable (and save)).
    XP2.0 disable enable detpage.png
    X-Payments 1.0: Click the [ enable ] / [ disable ] link below the 'Store name' field:
    Xp-11 store enabled.gif

Editing an Online Store's Details

To edit information about an online store:

  • On the 'Online Store Details' page:
    Edit the contents of any editable fields and click Save.

Deleting an Online Store

To delete an online store, do one of the following:

  • On the 'Online Stores' page:
    X-Payments 2.0 and later: Click the button dropdown element opposite the store name and select the required action (Delete store) from the menu. Confirm the deletion.
    X-Payments 1.0: Click the delete icon Xp-14 x button.gif opposite the store name. Confirm the deletion.
  • On the 'Online store details' page:
    X-Payments 2.0 and later: Click the button dropdown element near the 'Store name' field or at the bottom of the page and select the required action (Delete store).
    XP2.0 delete detpage.png
    Confirm the deletion.
    X-Payments 1.0: Click the Delete store link at the bottom of the page:
    Xp-12 delete store.gif
    Confirm the deletion.


PDF button.png This article can be downloaded as a PDF file
Retrieved from "https://www.x-payments.com/help/?title=X-Payments:Managing_store_connections&oldid=2897"