X-Payments:Configuring PayPal payment modules in X-Payments - Revision history

Dohtur at 13:26, 2 July 2019

2019-07-02T13:26:39Z

Dohtur at 12:35, 26 April 2018

2018-04-26T12:35:51Z

Dohtur at 11:35, 26 April 2018

2018-04-26T11:35:20Z

Dohtur at 11:25, 26 April 2018

2018-04-26T11:25:59Z

Dohtur at 11:19, 15 July 2015

2015-07-15T11:19:02Z

Dohtur at 11:17, 15 July 2015

2015-07-15T11:17:41Z

Dohtur at 11:16, 15 July 2015

2015-07-15T11:16:00Z

Dohtur at 11:13, 15 July 2015

2015-07-15T11:13:37Z

Dohtur: Created page with "This section provides an explanation of the configuration settings for the following PayPal payment modules in X-Payments: :* PayPal Payments Pro (Payflow API) :* PayPal Payme..."

2015-07-15T10:43:41Z

Created page with "This section provides an explanation of the configuration settings for the following PayPal payment modules in X-Payments: :* PayPal Payments Pro (Payflow API) :* PayPal Payme..."

New page

This section provides an explanation of the configuration settings for the following PayPal payment modules in X-Payments:
:* PayPal Payments Pro (Payflow API)
:* PayPal Payments Pro (PayPal API)
:* Payflow Pro

==PayPal Payments Pro (Payflow API) configuration settings==
The page allowing you to adjust a payment configuration for PayPal Payments Pro (Payflow API) is as follows:
:[[File:Paypal_payments_pro_payflow_api.png|border]] You need to adjust the following fields:
:* '''Name''': Any name that will help you to identify this payment configuration; for example, ''PayPal Payments Pro (Payflow)''.
:* '''Payment configuration is enabled''': If you do not wish the payment configuration to be enabled right after you are done adjusting its details, click [disable].
:* '''Partner name''': 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. {{Note1|'''Note:''' The values for the fields ''Partner name'', ''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.}}
:* '''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:PayPal#Testing_your_PayPal_payment_methods | Testing your PayPal payment methods]]').
:* '''Initial transaction''': Choose ''Auth'' 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. {{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).}}
:* '''Currency''': The currency that should be used for payments via this method.
:* '''Credit card types''': Credit card types you are going to accept.
:* '''Use in online stores''': If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
:* '''3-D Secure''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use external module (CardinalCommerce)" means that CardinalCommerce module will be used for payer authentication. If the latter option appears as "Use external module (none)", it means that CardinalCommerce module needs to be configured and enabled.

==PayPal Payments Pro (PayPal API) configuration settings==
<div id="PayPalPaymentsProPayPalAPIconfsettings"> </div>
The page allowing you to adjust a payment configuration for PayPal Payments Pro (PayPal API) is as follows:
:[[File:Paypal_payments_pro_paypal_api.png|border]] You need to adjust the following fields:
:* '''Name''': Any name that will help you to identify this payment configuration; for example, ''PayPal Payments Pro''.
:* '''Payment configuration is enabled''': If you do not wish the payment configuration to be enabled right after you are done adjusting its details, click [disable].
:* '''API Access Username''' and '''API Access Password''': Your API username and API password as provided by your PayPal account.
:* '''API method''': The type of authentication method that you are going to use (''Signature'' or ''Certificate''). The simplest authentication method is using an API Signature, an encrypted string value that you include with your API calls to identify yourself. Use this method if you want the fastest and easiest way to use the PayPal API. An API Certificate is a file that you download from PayPal that contains a private key and public certificate which identify you to PayPal. Use this method if you have full control of your web server and are familiar with SSL encryption. If you have chosen an API SSL client-side certificate as your credential, install the certificate on the web server in the directory <xp-dir>/lib/XPay/Module/PaypalWPPDirectPayment/, where <xp-dir> is the name of the directory in which X-Payments is installed.
:* '''Certificate''': If you have chosen ''Certificate'' as your PayPal authentication method, specify the filename of your API certificate. For example, if your API certificate filepath is <xp-dir>/lib/XPay/Module/PaypalWPPDirectPayment/cert_key.pem, you must enter cert_key.pem into this field.
:* '''Signature''': If you have chosen ''Signature'' as your PayPal authentication method, copy and paste your API signature into this field.
:* '''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:PayPal#Testing_your_PayPal_payment_methods | Testing your PayPal payment methods]]').
:* '''Initial transaction''': Choose ''Auth'' 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. {{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).}}
:* '''Currency''': The currency that should be used for payments via this method.
:* '''Credit card types''': Credit card types you are going to accept.
:* '''Call-back IPs''': IP addresses from which X-Payments will receive PayPal callback requests. You can find the list of PayPal IP addresses [https://ppmts.custhelp.com/app/answers/detail/a_id/92 here].
:* '''Use in online stores''': If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
:* '''3-D Secure''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use external module (CardinalCommerce)" means that CardinalCommerce module will be used for payer authentication. If the latter option appears as "Use external module (none)", it means that CardinalCommerce module needs to be configured and enabled.

==Payflow Pro configuration settings==
The page allowing you to adjust a payment configuration for Payflow Pro is as follows:
:[[File:Paypal_payflow_pro.png|border]] The configuration settings for Payflow Pro should be adjusted the same way as for [[#PayPal Payments Pro (Payflow API) configuration settings | PayPal Payments Pro (Payflow API)]].
:* '''Use built-in 3-D Secure feature''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use built-in 3-D Secure feature" means that payer authentication will be performed at the level of the module in X-Payments as well as at the level of your payment processor (You may need to enable this feature on the side of your payment processor.)

[[Category:X-Payments User Manual]]

@@ Line 11: / Line 11: @@
 :* '''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.<br />{{Note1|'''Note:''' The values for the fields ''Partner name'', ''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.}}
+:* '''Password''': The password for the user account denoted in the "User" field.<br />{{Note1|'''Note:''' The values for the fields ''Partner name'', ''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://manager.paypal.com.}}
 :* '''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 '[http://help.x-cart.com/index.php?title=X-Cart:PayPal#Testing_your_PayPal_payment_methods Testing your PayPal payment methods]').
 :* '''Initial transaction''': Choose ''Auth'' or ''Auth and capture''.

@@ Line 20: / Line 20: @@
 :* '''Cancel not captured''' Enable the checkbox option "Void not captured "auth only" payments in 30 days automatically" to ensure that the hold on the funds for which an authorization has been obtained is lifted automatically no later than 30 days after the payment if a capture of the funds has not been performed.
 :* '''Use in online stores''': (Available in X-Payments Multistore) If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
-:* If an Atifraud service and/or a 3-D Secure module have been configured for the current payment configuration, you may access the respective settings from this page.
+:* If an Antifraud service and/or a 3-D Secure module have been configured for the current payment configuration, you may access and adjust the respective settings from this page.
 ==PayPal Payments Pro (PayPal API) configuration settings==
@@ Line 39: / Line 39: @@
 :* '''Cancel not captured''' Enable the checkbox option "Void not captured "auth only" payments in 30 days automatically" to ensure that the hold on the funds for which an authorization has been obtained is lifted automatically no later than 30 days after the payment if a capture of the funds has not been performed.
 :* '''Use in online stores''': (Available in X-Payments Multistore) If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
-:* If an Atifraud service and/or a 3-D Secure module have been configured for the current payment configuration, you may access the respective settings from this page.
+:* If an Antifraud service and/or a 3-D Secure module have been configured for the current payment configuration, you may access and adjust the respective settings from this page.
 ==Payflow Pro configuration settings==
 The page allowing you to adjust a payment configuration for Payflow Pro is as follows:
 :[[File:Paypal_payflow_pro.png|border]]<br />The configuration settings for Payflow Pro should be adjusted the same way as for [[#PayPal Payments Pro (Payflow API) configuration settings | PayPal Payments Pro (Payflow API)]].
 [[Category:X-Payments User Manual]]

@@ Line 20: / Line 20: @@
 :* '''Cancel not captured''' Enable the checkbox option "Void not captured "auth only" payments in 30 days automatically" to ensure that the hold on the funds for which an authorization has been obtained is lifted automatically no later than 30 days after the payment if a capture of the funds has not been performed.
 :* '''Use in online stores''': (Available in X-Payments Multistore) If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
-:* '''3-D Secure''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use external module (CardinalCommerce)" means that CardinalCommerce module will be used for payer authentication. If the latter option appears as "Use external module (none)", it means that CardinalCommerce module needs to be configured and enabled.
+:* If an Atifraud service and/or a 3-D Secure module have been configured for the current payment configuration, you may access the respective settings from this page.
 ==PayPal Payments Pro (PayPal API) configuration settings==
@@ Line 39: / Line 39: @@
 :* '''Cancel not captured''' Enable the checkbox option "Void not captured "auth only" payments in 30 days automatically" to ensure that the hold on the funds for which an authorization has been obtained is lifted automatically no later than 30 days after the payment if a capture of the funds has not been performed.
 :* '''Use in online stores''': (Available in X-Payments Multistore) If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
-:* '''3-D Secure''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use external module (CardinalCommerce)" means that CardinalCommerce module will be used for payer authentication. If the latter option appears as "Use external module (none)", it means that CardinalCommerce module needs to be configured and enabled.
+:* If an Atifraud service and/or a 3-D Secure module have been configured for the current payment configuration, you may access the respective settings from this page.
 ==Payflow Pro configuration settings==
 The page allowing you to adjust a payment configuration for Payflow Pro is as follows:
 :[[File:Paypal_payflow_pro.png|border]]<br />The configuration settings for Payflow Pro should be adjusted the same way as for [[#PayPal Payments Pro (Payflow API) configuration settings | PayPal Payments Pro (Payflow API)]].
-:* '''Use built-in 3-D Secure feature''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use built-in 3-D Secure feature" means that payer authentication will be performed at the level of the module in X-Payments as well as at the level of your payment processor (You may need to enable this feature on the side of your payment processor.)
+:* If an Atifraud service and/or a 3-D Secure module have been configured for the current payment configuration, you may access the respective settings from this page.
 [[Category:X-Payments User Manual]]

@@ Line 13: / Line 13: @@
 :* '''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.<br />{{Note1|'''Note:''' The values for the fields ''Partner name'', ''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.}}
-:* '''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:PayPal#Testing_your_PayPal_payment_methods | Testing your PayPal payment methods]]').
+:* '''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 '[http://help.x-cart.com/index.php?title=X-Cart:PayPal#Testing_your_PayPal_payment_methods Testing your PayPal payment methods]').
 :* '''Initial transaction''': Choose ''Auth'' 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 online stores (refer to [http://help.x-cart.com/index.php?title=X-Cart:PayPal#This_invoice_has_already_been_paid._For_more_information.2C_please_contact_the_merchant this article] for more details).}}
@@ Line 31: / Line 31: @@
 :* '''Certificate''': If you have chosen ''Certificate'' as your PayPal authentication method, specify the filename of your API certificate. For example, if your API certificate filepath is <u><xp-dir>/lib/XPay/Module/PaypalWPPDirectPayment/cert_key.pem</u>, you must enter <u>cert_key.pem</u> into this field.
 :* '''Signature''': If you have chosen ''Signature'' as your PayPal authentication method, copy and paste your API signature into this field.
-:* '''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:PayPal#Testing_your_PayPal_payment_methods | Testing your PayPal payment methods]]').
+:* '''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 '[http://help.x-cart.com/index.php?title=X-Cart:PayPal#Testing_your_PayPal_payment_methods Testing your PayPal payment methods]').
 :* '''Initial transaction''': Choose ''Auth'' 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 online stores (refer to [http://help.x-cart.com/index.php?title=X-Cart:PayPal#This_invoice_has_already_been_paid._For_more_information.2C_please_contact_the_merchant this article] for more details).}}

@@ Line 8: / Line 8: @@
 :[[File:Paypal_payments_pro_payflow_api.png|border]]<br />You need to adjust the following fields:
 :* '''Name''': Any name that will help you to identify this payment configuration; for example, ''PayPal Payments Pro (Payflow)''.
 :* '''Partner name''': 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.
@@ Line 18: / Line 17: @@
 :* '''Currency''': The currency that should be used for payments via this method.
 :* '''Credit card types''': Credit card types you are going to accept.
-:* '''Use in online stores''': If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
+:* '''Call-back IPs''': IP addresses from which X-Payments will receive PayPal callback requests.
 :* '''3-D Secure''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use external module (CardinalCommerce)" means that CardinalCommerce module will be used for payer authentication. If the latter option appears as "Use external module (none)", it means that CardinalCommerce module needs to be configured and enabled.
@@ Line 26: / Line 27: @@
 :[[File:Paypal_payments_pro_paypal_api.png|border]]<br />You need to adjust the following fields:
 :* '''Name''': Any name that will help you to identify this payment configuration; for example, ''PayPal Payments Pro''.
 :* '''API Access Username''' and '''API Access Password''': Your API username and API password as provided by your PayPal account.
 :* '''API method''': The type of authentication method that you are going to use (''Signature'' or ''Certificate'').<br />The simplest authentication method is using an API Signature, an encrypted string value that you include with your API calls to identify yourself. Use this method if you want the fastest and easiest way to use the PayPal API.<br />An API Certificate is a file that you download from PayPal that contains a private key and public certificate which identify you to PayPal. Use this method if you have full control of your web server and are familiar with SSL encryption.<br />If you have chosen an API SSL client-side certificate as your credential, install the certificate on the web server in the directory <u><xp-dir>/lib/XPay/Module/PaypalWPPDirectPayment/</u>, where <u><xp-dir></u> is the name of the directory in which X-Payments is installed.
@@ Line 37: / Line 37: @@
 :* '''Credit card types''': Credit card types you are going to accept.
 :* '''Call-back IPs''': IP addresses from which X-Payments will receive PayPal callback requests. You can find the list of PayPal IP addresses [https://ppmts.custhelp.com/app/answers/detail/a_id/92 here].
-:* '''Use in online stores''': If you have already added some online stores in the 'Online Stores' section of the X-Payments back-end (Settings->Online Stores), here you will see the online stores you have added. Select the check box for your X-Cart store to enable the payment configuration in this store. If you haven't yet added your X-Cart store to the list of online stores working with X-Payments, you will be able to add the store and enable this payment configuration for it later after you are done defining the configuration settiongs for the PayPal Payments Pro (PayPal API) module on this page.
+:* '''Cancel not captured''' Enable the checkbox option "Void not captured "auth only" payments in 30 days automatically" to ensure that the hold on the funds for which an authorization has been obtained is lifted automatically no later than 30 days after the payment if a capture of the funds has not been performed.
 :* '''3-D Secure''': Specify whether you wish to enable 3-D Secure payer authentication. "Do not use" means that 3-D Secure will not be used. "Use external module (CardinalCommerce)" means that CardinalCommerce module will be used for payer authentication. If the latter option appears as "Use external module (none)", it means that CardinalCommerce module needs to be configured and enabled.