Difference between revisions of "Draft:Adjusting PayPal Configuration Settings in X-Cart"

From X-Cart 4 Classic
Jump to: navigation, search
m
m
Line 27: Line 27:
 
== PayPal Payments Pro configuration settings ==
 
== PayPal Payments Pro configuration settings ==
  
The following notes refer only to '<u>PayPal Payments Pro</u>' payment method. For notes on the configuration settings for '<u>Website Payments Pro Payflow Edition</u>', see the [[Draft:Adjusting_PayPal_Configuration_Settings_in_X-Cart#Website Payments Pro Payflow Edition configuration settings | Website Payments Pro Payflow Edition configuration settings]] section.<br /><br />
+
The following notes refer only to <u>PayPal Payments Pro</u> payment method using PayPal API. For notes on the configuration settings for <u>Website Payments Pro Payflow Edition</u> (the PayPal Payments Pro method using Payflow API), see the [[Draft:Adjusting_PayPal_Configuration_Settings_in_X-Cart#Website Payments Pro Payflow Edition configuration settings | Website Payments Pro Payflow Edition configuration settings]] section.<br /><br />
 
The configuration settings for PayPal Payments Pro are as follows:
 
The configuration settings for PayPal Payments Pro are as follows:
 
: [[File:Pp_payments_pro.png|border]]
 
: [[File:Pp_payments_pro.png|border]]
 
To ensure that PayPal Payments Pro integration will work correctly for your store, you must set the configuration settings in exactly the same way they have been set in X-Payments.
 
To ensure that PayPal Payments Pro integration will work correctly for your store, you must set the configuration settings in exactly the same way they have been set in X-Payments.
Select payment method configured on X-Payments side:
+
:* '''Select payment method configured on X-Payments side''': This needs to be set to ''X-Payments:PayPal Payments Pro''.
 +
:* '''API Access username''' and '''API Access password''': Your API Username and API Password as provided by your PayPal account.
 +
:* '''Use PayPal authentication method''': The type of authentication method that you would like to use (''API Signature'' or ''API Certificate''). If you choose to use an API SSL client-side certificate as your credential, install the certificate on the web server in the directory <u><xcart_dir>/payment/certs/</u>, where <u><xcart_dir></u> is the name of the directory in which X-Cart is installed.
 +
:* '''API certificate filename''': If you have chosen ''API certificate'' as your PayPal authentication method, specify the filename of your API certificate.
 +
:* '''API signature''': If you have chosen ''API signature'' as your PayPal authentication method, copy and paste your API signature into this field.
 +
:* '''Currency''': The currency that should be used for payments via this method..
 +
:* '''Test/Live mode''': PayPal operating mode. ('live' should be selected for live stores, 'test' - for testing. Information on using PayPal in test mode is provided in the section '[[X-Cart:Testing_PayPal_Integration | Testing X-Cart's PayPal Integration]]').
 +
:* '''Action to be performed on order placement''': The mode in which you wish payment transactions to be performed via PayPal on order placement (Auth only or Auth and Capture).
 +
:* '''Order prefix''': Your trading name or any other prefix that will help you to identify a payment transaction as originating from this store.<br />{{Note1 | '''Note:''': The "Order prefix" field is required when using the same PayPal account for several on-line stores (refer to [[X-Cart:PayPal#This_invoice_has_already_been_paid._For_more_information.2C_please_contact_the_merchant | this article]] for more details).}}
  
:* <u>API Access username</u> and <u>API Access password</u>: Your API Username and API Password as provided by your PayPal account.
 
:* <u>Use PayPal authentication method</u>: The type of authentication method that you would like to use (''API Signature'' or ''API Certificate''). If you choose to use an API SSL client-side certificate as your credential, install the certificate on the web server in the directory <u><xcart_dir>/payment/certs/</u>, where <u><xcart_dir></u> is the name of the directory in which X-Cart is installed.
 
:* <u>API certificate filename</u>: If you have chosen ''API certificate'' as your PayPal authentication method, specify the filename of your API certificate.
 
:* <u>API signature</u>: If you have chosen ''API signature'' as your PayPal authentication method, copy and paste your API signature into this field.
 
:* <u>Currency</u>: The currency that should be used for payments via this method..
 
:* <u>Test/Live mode</u>: PayPal operating mode. ('live' should be selected for live stores, 'test' - for testing. Information on using PayPal in test mode is provided in the section '[[X-Cart:Testing_PayPal_Integration | Testing X-Cart's PayPal Integration]]').
 
:* <u>Action to be performed on order placement</u>: The mode in which you wish payment transactions to be performed via PayPal on order placement (Auth only or Auth and Capture).
 
:* <u>Order prefix</u>: The prefix that will help you identify a payment transaction as originating from this store.<br />{{Note1 | '''Note:''': The "Order prefix" field is required when using the same PayPal account for several on-line stores (refer to [[X-Cart:PayPal#This_invoice_has_already_been_paid._For_more_information.2C_please_contact_the_merchant | this article]] for more details).}}
 
  
 +
== Website Payments Pro Payflow Edition configuration settings ==
  
== Website Payments Pro Payflow Edition configuration settings ==
+
The configuration settings for <u>Website Payments Pro Payflow Edition</u> are as follows:<br>[[Image:Pp_pro_payflow_edition.png|border]]
'''To adjust settings for Website Payments Pro Payflow Edition:'''
+
You need to adjust the following fields:
# In the '<u>Settings</u>' dialog box, select the option '<u>Website Payments Pro Payflow Edition</u>':<br>[[Image:Pp_pro_payflow_edition.png|border]]
 
Adjust the fields in the lower part of the dialog box as follows:
 
 
:* <u>Vendor</u>: The vendor name (login ID).
 
:* <u>Vendor</u>: The vendor name (login ID).
 
:* <u>Partner</u>: The partner name.
 
:* <u>Partner</u>: The partner name.

Revision as of 15:46, 17 December 2012

After you choose the PayPal payment method you would like to use at your store, you must adjust its configuration settings. The configuration settings for the chosen PayPal payment method are displayed in the lower part of the PayPal configuration page.

Following are some notes on adjusting the configuration settings for specific PayPal payment methods.


PayPal Payments Standard configuration settings

The configuration settings for PayPal Payments Standard are as follows:

Pp payments standard.png

You need to adjust the following fields:

  • Account: The email address you use to access your PayPal Business account.
  • Description of the purchase that will be displayed on PayPal payment page: A generic description of the purchase that should be displayed to the customer (i.e. books. music, etc). This field is optional.
  • Currency: The currency that should be used for payments via this method.
  • Order prefix: Your trading name or any other prefix that will help you to identify a payment transaction as originating from this store.
    Note:: The "Order prefix" field is required when using the same PayPal account for several online stores (refer to this article for more details).
  • Test/Live mode: PayPal operating mode ('live' should be selected for live stores, 'test' - for testing. Information on using PayPal in test mode is provided in the section ' Testing X-Cart's PayPal Integration').
  • Action to be performed on order placement: Choose Auth only or Auth and Capture.
  • Address override: When this option is enabled, the address specified by the customer during checkout in X-Cart and passed from X-Cart to PayPal overrides the PayPal member's stored address. The customer is shown the passed-in address but cannot edit it. When this option is disabled, the customer can edit the passed-in address or select another address that he/she has stored with PayPal.
    Note: Disabling this option may lead to a situation when the address specified by the customer during checkout in X-Cart and saved in the X-Cart order details differs from the address in the relevant PayPal transaction details. This can cause confusion as to which address the order should be shipped to.

If you have opted in for the Auth only action to be performed on order placement or if you are going to process refunds via X-Cart back-office, you must also provide your API access credentials:

Note: Help on retrieving your API access credentials is available here: http://qwyx.co/apihowto.
  • API access username: Your API access username as provided in your PayPal account profile.
  • API access password: Your API access password as provided in your PayPal account profile.
  • Use PayPal authentication method: The type of authentication method that you wish to use (API signature or API certificate). If you choose to use an API SSL client-side certificate as your credential, install the certificate on the web server in the directory <xcart_dir>/payment/certs/, where <xcart_dir> is the name of the directory in which X-Cart is installed.
  • API certificate filename: If you have chosen API certificate as your PayPal authentication method, specify the filename of your API certificate.
  • API signature: If you have chosen API signature as your PayPal authentication method, copy and paste your API signature into this field.

PayPal Payments Pro configuration settings

The following notes refer only to PayPal Payments Pro payment method using PayPal API. For notes on the configuration settings for Website Payments Pro Payflow Edition (the PayPal Payments Pro method using Payflow API), see the Website Payments Pro Payflow Edition configuration settings section.

The configuration settings for PayPal Payments Pro are as follows:

Pp payments pro.png

To ensure that PayPal Payments Pro integration will work correctly for your store, you must set the configuration settings in exactly the same way they have been set in X-Payments.

  • Select payment method configured on X-Payments side: This needs to be set to X-Payments:PayPal Payments Pro.
  • API Access username and API Access password: Your API Username and API Password as provided by your PayPal account.
  • Use PayPal authentication method: The type of authentication method that you would like to use (API Signature or API Certificate). If you choose to use an API SSL client-side certificate as your credential, install the certificate on the web server in the directory <xcart_dir>/payment/certs/, where <xcart_dir> is the name of the directory in which X-Cart is installed.
  • API certificate filename: If you have chosen API certificate as your PayPal authentication method, specify the filename of your API certificate.
  • API signature: If you have chosen API signature as your PayPal authentication method, copy and paste your API signature into this field.
  • Currency: The currency that should be used for payments via this method..
  • Test/Live mode: PayPal operating mode. ('live' should be selected for live stores, 'test' - for testing. Information on using PayPal in test mode is provided in the section ' Testing X-Cart's PayPal Integration').
  • Action to be performed on order placement: The mode in which you wish payment transactions to be performed via PayPal on order placement (Auth only or Auth and Capture).
  • Order prefix: Your trading name or any other prefix that will help you to identify a payment transaction as originating from this store.
    Note:: The "Order prefix" field is required when using the same PayPal account for several on-line stores (refer to this article for more details).


Website Payments Pro Payflow Edition configuration settings

The configuration settings for Website Payments Pro Payflow Edition are as follows:
Pp pro payflow edition.png You need to adjust the following fields:

  • Vendor: The vendor name (login ID).
  • Partner: The partner name.
  • User: Your user name, if used.
  • Password: Your password.
    Note:: The values for the fields 'Vendor', 'Partner', 'User' and 'Password' are supplied to you by PayPal after you sign up for Website Payments Pro Payflow Edition.
  • Currency: The currency that should be used for payments via this method.
  • Test/Live mode: PayPal operating mode. ('live' should be selected for live stores, 'test' - for testing. Information on using PayPal in test mode is provided in the section ' Testing X-Cart's PayPal Integration').
  • Action to be performed on order placement: The mode in which you wish payment transactions to be performed via PayPal on order placement (Auth only or Auth and Capture).
  • Order prefix: The prefix that will help you identify a payment transaction as originating from this store.
    Note:: The "Order prefix" field is required when using the same PayPal account for several on-line stores (refer to this article for more details).


No matter whether you configure Website Payments Pro or Website Payments Pro Payflow Edition, you will end up with two 'PayPal' entries under 'Payment Methods': one for Direct Payment and one for Express Checkout:
[[Image:]]
The names of PayPal methods suggested by X-Cart ('PayPal Pro: DirectPayment' and 'PayPal Pro: ExpressCheckout'), although quite informative for the store administrator, may not be informative enough for your customers. You by no means have to use the suggested names 'as is'. If you wish to change the names of your PayPal payment options, simply edit the corresponding names in the METHODS column and click the Update button.


Express Checkout configuration settings

To adjust settings for Express Checkout as an additional payment option:

  1. In the 'Settings' dialog box, select the 'Express Checkout' option:
    Pp express checkout.png
  2. Adjust the fields in the lower part of the dialog box the same way as for Website Payments Pro.
    Notes:
  • To use Express Checkout you must make the "Title" field not required on the User Profile page in the X-Cart Admin area. Express Checkout does not return the value of this field when the checkout is completed on the PayPal side, so if this field is required, X-Cart will not be able to complete checkout without it.
  • If you want PayPal Express Checkout to be available for customers from the US and Canada, make sure that the 'State' field is available to them during profile creation. If the 'State' field is not specified in the customer profile, PayPal Express Checkout will not function correctly.

PayPal Payments Advanced configuration settings

Pp payments advanced.png

Payflow Link configuration settings

Pp payflow link.png