Difference between revisions of "Draft:Adjusting PayPal Configuration Settings in X-Cart"
m |
m |
||
| Line 30: | Line 30: | ||
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''': This needs to be set to ''X-Payments:PayPal Payments Pro''. | :* '''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. | :* '''API Access username''' and '''API Access password''': Your API Username and API Password as provided by your PayPal account. | ||
| Line 39: | Line 39: | ||
:* '''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]]'). | :* '''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''': Choose ''Auth only'' or ''Auth and Capture''. | :* '''Action to be performed on order placement''': Choose ''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 | + | You can also adjust the following optional fields: |
| + | :* '''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 online 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).}} | ||
:* '''Express Checkout specific: Gradient color:''' and '''Express Checkout specific: Header Image URL:''' | :* '''Express Checkout specific: Gradient color:''' and '''Express Checkout specific: Header Image URL:''' | ||
| Line 46: | Line 47: | ||
The configuration settings for <u>Website Payments Pro Payflow Edition</u> are as follows:<br>[[Image:Pp_pro_payflow_edition.png|border]] | The configuration settings for <u>Website Payments Pro Payflow Edition</u> are as follows:<br>[[Image:Pp_pro_payflow_edition.png|border]] | ||
You need to adjust the following fields: | You need to adjust the following fields: | ||
| − | :* ''' | + | :* '''Partner''': Partner ID of the partner that signed you up for the account. If you signed up directly through PayPal, this will be "PayPal". |
| − | :* ''' | + | :* '''Merchant login''': The merchant login name that you chose when you signed up for the service. |
| − | :* '''User''': | + | :* '''User''': The username that you have set up for running transactions. If you have not specifically set up a username to run transactions, then this will be the same as the "Merchant login". |
| − | :* '''Password''': | + | :* '''Password''': The password for the user account denoted in the "User" field.<br />{{Note1 | '''Note:''': The values for the fields ''Partner'', ''Merchant login'', ''User'' and ''Password'' are your Payflow API credentials that were set up when you created your PayPal Manager (Payflow) account. They are the same as your PayPal Manager login at https://paypal.manager.com.}} |
:* '''Currency''': The currency that should be used for payments via this method. | :* '''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]]'). | :* '''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''': | + | :* '''Action to be performed on order placement''': Choose ''Auth only'' or ''Auth and Capture''. |
| − | :* '''Order prefix''': Your trading name or any other 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 | + | You can also adjust the following optional fields: |
| + | :* '''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 online 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).}} | ||
:* '''Express Checkout specific: Gradient color:''' and '''Express Checkout specific: Header Image URL:''' | :* '''Express Checkout specific: Gradient color:''' and '''Express Checkout specific: Header Image URL:''' | ||
| − | :* Express Checkout specific: Page Style: | + | :* '''Express Checkout specific: Page Style:''' |
== Express Checkout configuration settings== | == Express Checkout configuration settings== | ||
| − | + | The configuration settings for <u>PayPal Express Checkout</u> are as follows:<br />[[File:Pp_express_checkout.png|border]] | |
| − | + | You need to adjust the following fields: | |
| − | + | <br />{{Note1|'''Important:'''<br /> | |
| − | + | * If you intend to use Express Checkout, you must make the '''Title''' field not required on the User Profile page in X-Cart Admin area. Express Checkout does not return this value when checkout is completed on the PayPal side, so if this field is required, X-Cart will not be able to complete checkout without it.<br/> | |
| − | * | ||
| − | *If you want PayPal Express Checkout to be available | + | *If you want PayPal Express Checkout to be available to your customers in the US and Canada, make sure the ''State'' field is available to them during profile creation. If this field is not specified in the customer profile, PayPal Express Checkout will not function correctly.}} |
== PayPal Payments Advanced configuration settings == | == PayPal Payments Advanced configuration settings == | ||
Revision as of 00:21, 18 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.
Contents
PayPal Payments Standard configuration settings
The configuration settings for PayPal Payments Standard are as follows:
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. API access will be used to establish connection between X-Cart and PayPal API to perform Capture/Void/Refund transactions. Adjust the following fields:
- 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:
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: Choose Auth only or Auth and Capture.
You can also adjust the following optional fields:
- 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).
- Express Checkout specific: Gradient color: and Express Checkout specific: Header Image URL:
- Order prefix: Your trading name or any other prefix that will help you to identify a payment transaction as originating from this store.
Website Payments Pro Payflow Edition configuration settings
The configuration settings for Website Payments Pro Payflow Edition are as follows:
You need to adjust the following fields:
- Partner: Partner ID of the partner that signed you up for the account. If you signed up directly through PayPal, this will be "PayPal".
- Merchant login: The merchant login name that you chose when you signed up for the service.
- User: The username that you have set up for running transactions. If you have not specifically set up a username to run transactions, then this will be the same as the "Merchant login".
- Password: The password for the user account denoted in the "User" field.Note:: The values for the fields Partner, Merchant login, User and Password are your Payflow API credentials that were set up when you created your PayPal Manager (Payflow) account. They are the same as your PayPal Manager login at https://paypal.manager.com.
- 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: Choose Auth only or Auth and Capture.
You can also adjust the following optional fields:
- 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).
- Express Checkout specific: Gradient color: and Express Checkout specific: Header Image URL:
- Express Checkout specific: Page Style:
- Order prefix: Your trading name or any other prefix that will help you to identify a payment transaction as originating from this store.
Express Checkout configuration settings
The configuration settings for PayPal Express Checkout are as follows:
You need to adjust the following fields:
Important:
- If you intend to use Express Checkout, you must make the Title field not required on the User Profile page in X-Cart Admin area. Express Checkout does not return this value when 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 to your customers in the US and Canada, make sure the State field is available to them during profile creation. If this field is not specified in the customer profile, PayPal Express Checkout will not function correctly.
PayPal Payments Advanced configuration settings
Payflow Link configuration settings
