templates/CRM/Admin/Page/PaymentProcessor.hlp

   1 {*
   2  +--------------------------------------------------------------------+
   3  | CiviCRM version 5                                                  |
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC (c) 2004-2019                                |
   6  +--------------------------------------------------------------------+
   7  | This file is a part of CiviCRM.                                    |
   8  |                                                                    |
   9  | CiviCRM is free software; you can copy, modify, and distribute it  |
  10  | under the terms of the GNU Affero General Public License           |
  11  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  12  |                                                                    |
  13  | CiviCRM is distributed in the hope that it will be useful, but     |
  14  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  15  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  16  | See the GNU Affero General Public License for more details.        |
  17  |                                                                    |
  18  | You should have received a copy of the GNU Affero General Public   |
  19  | License and the CiviCRM Licensing Exception along                  |
  20  | with this program; if not, contact CiviCRM LLC                     |
  21  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  22  | GNU Affero General Public License or the licensing of CiviCRM,     |
  23  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  24  +--------------------------------------------------------------------+
  25 *}
  26 {htxt id='proc-type-title'}
  27   {ts}Payment Processors{/ts}
  28 {/htxt}
  29 {htxt id='proc-type'}
  30 <p>{ts}Refer to the following documentation:{/ts}</p>
  31 <ul>
  32   <li>{docURL page="user/contributions/payment-processors" text="Payment processor overview"}</li>
  33   <li>{docURL page="Payment Processors" text="Processor comparison and setup guide" resource="wiki"}</li>
  34 </ul>
  35 <p>{ts}If you're not sure which processor to use - we recommend reviewing terms, limitations and coverage areas on each processor's website before proceeding.{/ts}</p>
  36 <p>{ts 1="https://civicrm.org/extensions/civicrm?cat=125"}If your desired processor is not in the list, check the <a href="%1">Extensions Directory</a> for more payment processors you can download. If you still can't find it, consider partnering with a developer and contributing a new extension.{/ts}</p>
  37 {/htxt}
  38
  39 {htxt id='AuthNet-live-user-name'}
  40 {ts}Generate your API Login and Transaction Key by logging in to your Merchant Account and navigating to <strong>Settings &raquo; General Security Settings</strong>.{/ts}</p>
  41 {/htxt}
  42 {htxt id='AuthNet-live-password'}
  43 {ts}Generate your API Login and Transaction Key by logging in to your Merchant Account and navigating to <strong>Settings &raquo; General Security Settings</strong>.{/ts}</p>
  44 {/htxt}
  45 {htxt id='AuthNet-live-signature'}
  46 {ts}You may also optionally set an MD5 Hash Key to verify that responses come directly from Authorize.Net. Login to your merchant account and navigate to <strong>Account Settings</strong>. Select MD5-Hash and enter a new hash value. This can be just about any string of characters or words. Then enter the exact same value here.{/ts}</p>
  47 {/htxt}
  48 {htxt id='AuthNet-live-url-site'}
  49 {ts}The URL for Authorize.net's LIVE Payment server. Use the default value unless otherwise advised by the processor.{/ts}
  50 {/htxt}
  51 {htxt id='AuthNet-live-url-recur'}
  52 {ts}The URL for recurring payments. Use the default value unless otherwise advised by the processor.{/ts}
  53 {/htxt}
  54 {htxt id='AuthNet-test-user-name'}
  55 {ts}Generate your API Login and Transaction Key by logging in to your Merchant Account and navigating to <strong>Settings &raquo; General Security Settings</strong>.{/ts}</p>
  56 {/htxt}
  57 {htxt id='AuthNet-test-password'}
  58 {ts}Generate your API Login and Transaction Key by logging in to your Merchant Account and navigating to <strong>Settings &raquo; General Security Settings</strong>.{/ts}</p>
  59 {/htxt}
  60 {htxt id='AuthNet-test-signature'}
  61 {ts}You may also optionally set an MD5 Hash Key to verify that responses come directly from Authorize.Net. Login to your merchant account and navigate to <strong>Account Settings</strong>. Select MD5-Hash and enter a new hash value. This can be just about any string of characters or words. Then enter the exact same value here.{/ts}</p>
  62 {/htxt}
  63 {htxt id='AuthNet-test-url-site'}
  64 {ts}The URL for Authorize.net's TEST Payment server. Use the default value unless otherwise advised by the processor.{/ts}
  65 {/htxt}
  66 {htxt id='AuthNet-test-url-recur'}
  67 {ts}The URL for recurring payments. Use the default value unless otherwise advised by the processor.{/ts}
  68 {/htxt}
  69
  70 {htxt id='PayPal-live-user-name'}
  71 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Username</strong> as displayed in your LIVE account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
  72 {/htxt}
  73 {htxt id='PayPal-live-password'}
  74 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Password</strong> as displayed in your LIVE account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
  75 {/htxt}
  76 {htxt id='PayPal-live-signature'}
  77 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Signature</strong> as displayed in your LIVE account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
  78 {/htxt}
  79 {htxt id='PayPal-live-url-site'}
  80 {ts}The URL for PayPal's LIVE Payment server. Use the default value (unless otherwise advised by PayPal):{/ts}<br /> https://www.paypal.com/
  81 {/htxt}
  82 {htxt id='PayPal-live-url-api'}
  83 {ts}The URL for PayPal's LIVE API gateway server. Use the default value (unless otherwise advised by PayPal):{/ts}<br />https://api-3t.paypal.com/
  84 {/htxt}
  85 {htxt id='PayPal-live-url-button'}
  86 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
  87 {/htxt}
  88 {htxt id='PayPal-test-user-name'}
  89 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Username</strong> as displayed in your TEST (sandbox) account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
  90 {/htxt}
  91 {htxt id='PayPal-test-password'}
  92 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Password</strong> as displayed in your TEST (sandbox) account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
  93 {/htxt}
  94 {htxt id='PayPal-test-signature'}
  95 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Signature</strong> as displayed in your TEST (sandbox) account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
  96 {/htxt}
  97 {htxt id='PayPal-test-url-site'}
  98 {ts}The URL for PayPal's TEST Payment server. Use the default value (unless otherwise advised by PayPal):{/ts}<br />https://www.sandbox.paypal.com/
  99 {/htxt}
 100 {htxt id='PayPal-test-url-api'}
 101 {ts}The URL for PayPal's TEST API gateway server. Use the default value (unless otherwise advised by PayPal):{/ts}<br />https://api-3t.sandbox.paypal.com/
 102 {/htxt}
 103 {htxt id='PayPal-test-url-button'}
 104 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
 105 {/htxt}
 106
 107 {htxt id='PayPal_Express-live-user-name'}
 108 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Username</strong> as displayed in your LIVE account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
 109 {/htxt}
 110 {htxt id='PayPal_Express-live-password'}
 111 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Password</strong> as displayed in your LIVE account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
 112 {/htxt}
 113 {htxt id='PayPal_Express-live-signature'}
 114 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Signature</strong> as displayed in your LIVE account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
 115 {/htxt}
 116 {htxt id='PayPal_Express-live-url-site'}
 117 {ts}The URL for PayPal's LIVE Payment server. Use the default value (unless otherwise advised by PayPal):{/ts}<br /> https://www.paypal.com/
 118 {/htxt}
 119 {htxt id='PayPal_Express-live-url-api'}
 120 {ts}The URL for PayPal's LIVE API gateway server. Use the default value (unless otherwise advised by PayPal):{/ts}<br />https://api-3t.paypal.com/
 121 {/htxt}
 122 {htxt id='PayPal_Express-live-url-button'}
 123 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
 124 {/htxt}
 125 {htxt id='PayPal_Express-test-user-name'}
 126 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Username</strong> as displayed in your TEST (sandbox) account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
 127 {/htxt}
 128 {htxt id='PayPal_Express-test-password'}
 129 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Password</strong> as displayed in your TEST (sandbox) account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
 130 {/htxt}
 131 {htxt id='PayPal_Express-test-signature'}
 132 {ts}CiviCRM requires that you use the <strong>Signature-based API Credentials</strong> for PayPal Pro and Express. Enter your <strong>API Signature</strong> as displayed in your TEST (sandbox) account's <strong>Profile - View API Signature</strong> screen.{/ts}</p>
 133 {/htxt}
 134 {htxt id='PayPal_Express-test-url-site'}
 135 {ts}The URL for PayPal's TEST Payment server. Use the default value (unless otherwise advised by PayPal):{/ts}<br />https://www.sandbox.paypal.com/
 136 {/htxt}
 137 {htxt id='PayPal_Express-test-url-api'}
 138 {ts}The URL for PayPal's TEST API gateway server. Use the default value (unless otherwise advised by PayPal):{/ts}<br />https://api-3t.sandbox.paypal.com/
 139 {/htxt}
 140 {htxt id='PayPal_Express-test-url-button'}
 141 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
 142 {/htxt}
 143
 144 {htxt id='PayPal_Standard-live-user-name'}
 145 {ts}Enter the Merchant Account Email Address linked to your LIVE PayPal Merchant Account.{/ts}</p>
 146 {/htxt}
 147 {htxt id='PayPal_Standard-live-url-site'}
 148 {ts}The URL for PayPal's LIVE Payment server. Use the default value unless otherwise indicated by PayPal.{/ts}
 149 {/htxt}
 150 {htxt id='PayPal_Standard-live-url-recur'}
 151 {ts}The URL for PayPal Standard recurring payments. Use the default value unless otherwise indicated by PayPal.{/ts}
 152 {/htxt}
 153 {htxt id='PayPal_Standard-test-user-name'}
 154 {ts}Enter the Merchant Account Email Address linked to your PayPal Sandbox merchant account (NOT your Developer Central login - unless it's the same).{/ts}</p>
 155 {/htxt}
 156 {htxt id='PayPal_Standard-test-url-site'}
 157 {ts}The URL for PayPal's TEST Payment server. Use the default value unless otherwise indicated by PayPal.{/ts}
 158 {/htxt}
 159 {htxt id='PayPal_Standard-test-url-recur'}
 160 {ts}The URL for PayPal Standard recurring payments. Use the default value unless otherwise indicated by PayPal.{/ts}
 161 {/htxt}
 162
 163 {htxt id='PayJunction-test-user-name'}
 164 <p>{ts}Enter <strong>pj-ql-01</strong>. This is the User Name associated with the shared PayJunction test account.{/ts}</p>
 165 {/htxt}
 166 {htxt id='PayJunction-test-password'}
 167 <p>{ts}Enter <strong>pj-ql-01p</strong>. This is the Password associated with the shared PayJunction test account.{/ts}</p>
 168 {/htxt}
 169 {htxt id='PayJunction-test-url-site'}
 170 {ts}The URL for PayJunction's Payment server. This is the same for TEST and LIVE transactions. Use the default value unless otherwise advised by PayJunction.{/ts}
 171 {/htxt}
 172 {htxt id='PayJunction-test-url-recur'}
 173 <p>{ts}The Recurring Payments URL is not currently used.{/ts}</p>
 174 {/htxt}
 175
 176 {htxt id='PayJunction-live-user-name'}
 177 <p>{ts}Enter the User Name associated with your LIVE merchant account.{/ts}</p>
 178 {/htxt}
 179 {htxt id='PayJunction-live-password'}
 180 <p>{ts}Enter the Password associated with your LIVE merchant account.{/ts}</p>
 181 {/htxt}
 182 {htxt id='PayJunction-live-url-site'}
 183 {ts}The URL for PayJunction's Payment server. This is the same for TEST and LIVE transactions. Use the default value unless otherwise advised by PayJunction.{/ts}
 184 {/htxt}
 185 {htxt id='PayJunction-live-url-recur'}
 186 <p>{ts}The Recurring Payments URL is not currently used.{/ts}</p>
 187 {/htxt}
 188
 189 {htxt id='Dummy-live-user-name'}
 190 {ts}Set up a 'Dummy' Processor if you want to test Online Contribution pages or Event Registration pages prior to selecting and configuring a real payment processor. You can enter any values for User Name and Site URL.{/ts}</p>
 191 {/htxt}
 192 {htxt id='Dummy-live-url-site'}
 193 {ts}Set up a 'Dummy' Processor if you want to test Online Contribution pages or Event Registration pages prior to selecting and configuring a real payment processor. You can enter any values for User Name and Site URL.{/ts}</p>
 194 {/htxt}
 195 {htxt id='Dummy-test-user-name'}
 196 {ts}Set up a 'Dummy' Processor if you want to test Online Contribution pages or Event Registration pages prior to selecting and configuring a real payment processor. You can enter any values for User Name and Site URL.{/ts}</p>
 197 {/htxt}
 198 {htxt id='Dummy-test-url-site'}
 199 {ts}Set up a 'Dummy' Processor if you want to test Online Contribution pages or Event Registration pages prior to selecting and configuring a real payment processor. You can enter any values for User Name and Site URL.{/ts}</p>
 200 {/htxt}
 201
 202 {htxt id='eWAY-test-user-name'}
 203 <p>{ts 1='<strong>eWAYCustomerID</strong>'}This is the TEST %1 used solely for testing.{/ts}
 204 <br />{ts 1='<strong>87654321</strong>'}Use %1 unless otherwise advised by eWAY.{/ts}
 205 <br />{ts 1='<strong>4444333322221111</strong>'}The test Credit Card number is %1 - this is the only credit card number that will work on the test gateway.{/ts}
 206 <br />{ts 1='00' 2='08'}The test Total Amount should end in <strong>%1</strong> or <strong>%2</strong> to get a successful response (e.g. $10.%1 or $10.%2) - all other amounts will return a failed response.{/ts}</p>
 207 {/htxt}
 208 {htxt id='eWAY-test-url-site'}
 209 {ts}The <strong>URL</strong> for eWAY's TEST Gateway.{/ts}
 210 <br />{ts 1='<strong>https://www.eway.com.au/gateway_cvn/xmltest/testpage.asp</strong>'}Use %1 unless otherwise advised by eWAY.{/ts}
 211 {/htxt}
 212
 213 {htxt id='eWAY-live-user-name'}
 214 <p>{ts}This is the LIVE <strong>eWAYCustomerID</strong> associated with your eWAY account.{/ts}</p>
 215 {/htxt}
 216 {htxt id='eWAY-live-url-site'}
 217 {ts}The <strong>URL</strong> for eWAY's LIVE Gateway.{/ts}
 218 <br />{ts 1='<strong>https://www.eway.com.au/gateway_cvn/xmlpayment.asp</strong>'}Use %1 unless otherwise advised by eWAY.{/ts}
 219 {/htxt}
 220
 221 {htxt id='Payment_Express-test-user-name'} {ts}Payment Express UserID (Development account):{/ts}
 222 {ts}This is the development user name provided to you by DPS/Payment Express.{/ts}
 223 {ts 1='4111111111111111' 2='76'}The test Credit Card number is %1 - this is the only credit card number that will work on the test gateway. The test Total Amount can be any amount except one that ends in a value of .%2 (e.g. $10.%2) - all amounts ending in .%2 will return a failed response.{/ts}
 224 {/htxt}
 225
 226 {htxt id='Payment_Express-test-url-site'} {ts}This is the URL for accessing the DPS/Payment Express payment site. If you have been given a MAC key please fill in the Mac Key field, and use https://sec.paymentexpress.com/pxpay/pxpay.aspx for the Site URL. Otherwise use https://sec.paymentexpress.com/pxpay/pxaccess.aspx for the Site URL.{/ts} {/htxt}
 227
 228 {htxt id='Payment_Express-live-user-name'} {ts}Payment Express UserID (LIVE account):{/ts}
 229 {ts}This is the live user name provided to you by DPS/Payment Express.{/ts}{/htxt}
 230
 231 {htxt id='Payment_Express-live-url-site'} {ts}This is the URL for accessing the DPS/Payment Express payment site. If you have been given a MAC key please fill in the Mac Key field, and use https://sec.paymentexpress.com/pxpay/pxpay.aspx for the Site URL. Otherwise use https://sec.paymentexpress.com/pxpay/pxaccess.aspx for the Site URL.{/ts} {/htxt}
 232
 233 {htxt id='Elavon-live-user-name'}
 234 <p>{ts}This is the LIVE <strong>Elavon Merchant ID</strong> associated with your Elavon account.{/ts}</p>
 235 {/htxt}
 236 {htxt id='Elavon-live-password'}
 237 <p>{ts}This is the LIVE <strong>Elavon User ID</strong> associated with your Elavon account.{/ts}</p>
 238 {/htxt}
 239 {htxt id='Elavon-live-signature'}
 240 <p>{ts}This is the LIVE <strong>Elavon SSL PIN</strong> associated with your Elavon account.{/ts}</p>
 241 {/htxt}
 242 {htxt id='Elavon-live-url-site'}
 243 <p>{ts}Use 'https://www.myvirtualmerchant.com/VirtualMerchant/processxml.do' unless otherwise advised by Elavon..{/ts}</p>
 244 {/htxt}
 245
 246 {htxt id='Elavon-test-user-name'}
 247 <p>{ts}This is the TEST <strong>Elavon Merchant ID</strong> associated with your Elavon account.{/ts}</p>
 248 {/htxt}
 249 {htxt id='Elavon-test-password'}
 250 <p>{ts}This is the TEST <strong>Elavon User ID</strong> associated with your Elavon account.{/ts}</p>
 251 {/htxt}
 252 {htxt id='Elavon-test-signature'}
 253 <p>{ts}This is the TEST <strong>Elavon SSL PIN</strong> associated with your Elavon account.{/ts}</p>
 254 {/htxt}
 255 {htxt id='Elavon-test-url-site'}
 256 <p>{ts}Use 'https://www.myvirtualmerchant.com/VirtualMerchant/processxml.do' unless otherwise advised by Elavon.{/ts}</p>
 257 {/htxt}
 258
 259 {htxt id='FirstData-live-user-name'}
 260 <p>{ts}This is the LIVE <strong>First Data Store Name</strong> associated with your First Data account (This is Certificate file number without the extension).{/ts}</p>
 261 {/htxt}
 262 {htxt id='FirstData-live-password'}
 263 <p>{ts}This is the LIVE <strong>Certificate Path</strong> associated with your First Data account.{/ts}</p>
 264 {/htxt}
 265 {htxt id='FirstData-live-url-site'}
 266 <p>{ts}The URL for First Data's Live Payment server. Use the default value (unless otherwise advised by First Data):{/ts}<br />https://secure.linkpt.net</p>
 267 {/htxt}
 268 {htxt id='FirstData-test-user-name'}
 269 <p>{ts}This is the TEST <strong>First Data Store Name</strong> associated with your First Data account (This is Certificate file number without the extension).{/ts}</p>
 270 {/htxt}
 271 {htxt id='FirstData-test-password'}
 272 <p>{ts}This is the TEST <strong>Certificate Path</strong> associated with your First Data account.{/ts}</p>
 273 {/htxt}
 274 {htxt id='FirstData-test-url-site'}
 275 <p>{ts}The URL for First Data's TEST Payment server. Use the default value (unless otherwise advised by First Data):{/ts}<br />https://staging.linkpt.net</p>
 276 {/htxt}