templates/CRM/Admin/Page/PaymentProcessor.hlp

   1 {*
   2  +--------------------------------------------------------------------+
   3  | Copyright CiviCRM LLC. All rights reserved.                        |
   4  |                                                                    |
   5  | This work is published under the GNU AGPLv3 license with some      |
   6  | permitted exceptions and without any warranty. For full license    |
   7  | and copyright information, see https://civicrm.org/licensing       |
   8  +--------------------------------------------------------------------+
   9 *}
  10 {htxt id='proc-type-title'}
  11   {ts}Payment Processors{/ts}
  12 {/htxt}
  13 {htxt id='proc-type'}
  14 <p>{ts}Refer to the following documentation:{/ts}</p>
  15 <ul>
  16   <li>{docURL page="user/contributions/payment-processors" text="Payment processor overview"}</li>
  17   <li>{docURL page="Payment Processors" text="Processor comparison and setup guide" resource="wiki"}</li>
  18 </ul>
  19 <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>
  20 <p>{ts 1="https://civicrm.org/extensions?tid_4[]=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>
  21 {/htxt}
  22
  23 {htxt id='AuthNet-live-user-name'}
  24 {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>
  25 {/htxt}
  26 {htxt id='AuthNet-live-password'}
  27 {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>
  28 {/htxt}
  29 {htxt id='AuthNet-live-signature'}
  30 {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>
  31 {/htxt}
  32 {htxt id='AuthNet-live-url-site'}
  33 {ts}The URL for Authorize.net's LIVE Payment server. Use the default value unless otherwise advised by the processor.{/ts}
  34 {/htxt}
  35 {htxt id='AuthNet-live-url-recur'}
  36 {ts}The URL for recurring payments. Use the default value unless otherwise advised by the processor.{/ts}
  37 {/htxt}
  38 {htxt id='AuthNet-test-user-name'}
  39 {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>
  40 {/htxt}
  41 {htxt id='AuthNet-test-password'}
  42 {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>
  43 {/htxt}
  44 {htxt id='AuthNet-test-signature'}
  45 {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>
  46 {/htxt}
  47 {htxt id='AuthNet-test-url-site'}
  48 {ts}The URL for Authorize.net's TEST Payment server. Use the default value unless otherwise advised by the processor.{/ts}
  49 {/htxt}
  50 {htxt id='AuthNet-test-url-recur'}
  51 {ts}The URL for recurring payments. Use the default value unless otherwise advised by the processor.{/ts}
  52 {/htxt}
  53
  54 {htxt id='PayPal-live-user-name'}
  55 {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>
  56 {/htxt}
  57 {htxt id='PayPal-live-password'}
  58 {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>
  59 {/htxt}
  60 {htxt id='PayPal-live-signature'}
  61 {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>
  62 {/htxt}
  63 {htxt id='PayPal-live-url-site'}
  64 {ts}The URL for PayPal's LIVE Payment server. Use the default value (unless otherwise advised by PayPal):{/ts}<br /> https://www.paypal.com/
  65 {/htxt}
  66 {htxt id='PayPal-live-url-api'}
  67 {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/
  68 {/htxt}
  69 {htxt id='PayPal-live-url-button'}
  70 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
  71 {/htxt}
  72 {htxt id='PayPal-test-user-name'}
  73 {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>
  74 {/htxt}
  75 {htxt id='PayPal-test-password'}
  76 {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>
  77 {/htxt}
  78 {htxt id='PayPal-test-signature'}
  79 {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>
  80 {/htxt}
  81 {htxt id='PayPal-test-url-site'}
  82 {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/
  83 {/htxt}
  84 {htxt id='PayPal-test-url-api'}
  85 {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/
  86 {/htxt}
  87 {htxt id='PayPal-test-url-button'}
  88 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
  89 {/htxt}
  90
  91 {htxt id='PayPal_Express-live-user-name'}
  92 {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>
  93 {/htxt}
  94 {htxt id='PayPal_Express-live-password'}
  95 {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>
  96 {/htxt}
  97 {htxt id='PayPal_Express-live-signature'}
  98 {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>
  99 {/htxt}
 100 {htxt id='PayPal_Express-live-url-site'}
 101 {ts}The URL for PayPal's LIVE Payment server. Use the default value (unless otherwise advised by PayPal):{/ts}<br /> https://www.paypal.com/
 102 {/htxt}
 103 {htxt id='PayPal_Express-live-url-api'}
 104 {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/
 105 {/htxt}
 106 {htxt id='PayPal_Express-live-url-button'}
 107 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
 108 {/htxt}
 109 {htxt id='PayPal_Express-test-user-name'}
 110 {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>
 111 {/htxt}
 112 {htxt id='PayPal_Express-test-password'}
 113 {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>
 114 {/htxt}
 115 {htxt id='PayPal_Express-test-signature'}
 116 {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>
 117 {/htxt}
 118 {htxt id='PayPal_Express-test-url-site'}
 119 {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/
 120 {/htxt}
 121 {htxt id='PayPal_Express-test-url-api'}
 122 {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/
 123 {/htxt}
 124 {htxt id='PayPal_Express-test-url-button'}
 125 {ts}The URL for displaying PayPal's 'Pay with PayPal' payment button image. Use the default value unless otherwise advised by PayPal.{/ts}
 126 {/htxt}
 127
 128 {htxt id='PayPal_Standard-live-user-name'}
 129 {ts}Enter the Merchant Account Email Address linked to your LIVE PayPal Merchant Account.{/ts}</p>
 130 {/htxt}
 131 {htxt id='PayPal_Standard-live-url-site'}
 132 {ts}The URL for PayPal's LIVE Payment server. Use the default value unless otherwise indicated by PayPal.{/ts}
 133 {/htxt}
 134 {htxt id='PayPal_Standard-live-url-recur'}
 135 {ts}The URL for PayPal Standard recurring payments. Use the default value unless otherwise indicated by PayPal.{/ts}
 136 {/htxt}
 137 {htxt id='PayPal_Standard-test-user-name'}
 138 {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>
 139 {/htxt}
 140 {htxt id='PayPal_Standard-test-url-site'}
 141 {ts}The URL for PayPal's TEST Payment server. Use the default value unless otherwise indicated by PayPal.{/ts}
 142 {/htxt}
 143 {htxt id='PayPal_Standard-test-url-recur'}
 144 {ts}The URL for PayPal Standard recurring payments. Use the default value unless otherwise indicated by PayPal.{/ts}
 145 {/htxt}
 146
 147 {htxt id='PayJunction-test-user-name'}
 148 <p>{ts}Enter <strong>pj-ql-01</strong>. This is the User Name associated with the shared PayJunction test account.{/ts}</p>
 149 {/htxt}
 150 {htxt id='PayJunction-test-password'}
 151 <p>{ts}Enter <strong>pj-ql-01p</strong>. This is the Password associated with the shared PayJunction test account.{/ts}</p>
 152 {/htxt}
 153 {htxt id='PayJunction-test-url-site'}
 154 {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}
 155 {/htxt}
 156 {htxt id='PayJunction-test-url-recur'}
 157 <p>{ts}The Recurring Payments URL is not currently used.{/ts}</p>
 158 {/htxt}
 159
 160 {htxt id='PayJunction-live-user-name'}
 161 <p>{ts}Enter the User Name associated with your LIVE merchant account.{/ts}</p>
 162 {/htxt}
 163 {htxt id='PayJunction-live-password'}
 164 <p>{ts}Enter the Password associated with your LIVE merchant account.{/ts}</p>
 165 {/htxt}
 166 {htxt id='PayJunction-live-url-site'}
 167 {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}
 168 {/htxt}
 169 {htxt id='PayJunction-live-url-recur'}
 170 <p>{ts}The Recurring Payments URL is not currently used.{/ts}</p>
 171 {/htxt}
 172
 173 {htxt id='Dummy-live-user-name'}
 174 {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>
 175 {/htxt}
 176 {htxt id='Dummy-live-url-site'}
 177 {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>
 178 {/htxt}
 179 {htxt id='Dummy-test-user-name'}
 180 {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>
 181 {/htxt}
 182 {htxt id='Dummy-test-url-site'}
 183 {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>
 184 {/htxt}
 185
 186 {htxt id='eWAY-test-user-name'}
 187 <p>{ts 1='<strong>eWAYCustomerID</strong>'}This is the TEST %1 used solely for testing.{/ts}
 188 <br />{ts 1='<strong>87654321</strong>'}Use %1 unless otherwise advised by eWAY.{/ts}
 189 <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}
 190 <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>
 191 {/htxt}
 192 {htxt id='eWAY-test-url-site'}
 193 {ts}The <strong>URL</strong> for eWAY's TEST Gateway.{/ts}
 194 <br />{ts 1='<strong>https://www.eway.com.au/gateway_cvn/xmltest/testpage.asp</strong>'}Use %1 unless otherwise advised by eWAY.{/ts}
 195 {/htxt}
 196
 197 {htxt id='eWAY-live-user-name'}
 198 <p>{ts}This is the LIVE <strong>eWAYCustomerID</strong> associated with your eWAY account.{/ts}</p>
 199 {/htxt}
 200 {htxt id='eWAY-live-url-site'}
 201 {ts}The <strong>URL</strong> for eWAY's LIVE Gateway.{/ts}
 202 <br />{ts 1='<strong>https://www.eway.com.au/gateway_cvn/xmlpayment.asp</strong>'}Use %1 unless otherwise advised by eWAY.{/ts}
 203 {/htxt}
 204
 205 {htxt id='Payment_Express-test-user-name'} {ts}Payment Express UserID (Development account):{/ts}
 206 {ts}This is the development user name provided to you by DPS/Payment Express.{/ts}
 207 {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}
 208 {/htxt}
 209
 210 {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}
 211
 212 {htxt id='Payment_Express-live-user-name'} {ts}Payment Express UserID (LIVE account):{/ts}
 213 {ts}This is the live user name provided to you by DPS/Payment Express.{/ts}{/htxt}
 214
 215 {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}
 216
 217 {htxt id='Elavon-live-user-name'}
 218 <p>{ts}This is the LIVE <strong>Elavon Merchant ID</strong> associated with your Elavon account.{/ts}</p>
 219 {/htxt}
 220 {htxt id='Elavon-live-password'}
 221 <p>{ts}This is the LIVE <strong>Elavon User ID</strong> associated with your Elavon account.{/ts}</p>
 222 {/htxt}
 223 {htxt id='Elavon-live-signature'}
 224 <p>{ts}This is the LIVE <strong>Elavon SSL PIN</strong> associated with your Elavon account.{/ts}</p>
 225 {/htxt}
 226 {htxt id='Elavon-live-url-site'}
 227 <p>{ts}Use 'https://www.myvirtualmerchant.com/VirtualMerchant/processxml.do' unless otherwise advised by Elavon..{/ts}</p>
 228 {/htxt}
 229
 230 {htxt id='Elavon-test-user-name'}
 231 <p>{ts}This is the TEST <strong>Elavon Merchant ID</strong> associated with your Elavon account.{/ts}</p>
 232 {/htxt}
 233 {htxt id='Elavon-test-password'}
 234 <p>{ts}This is the TEST <strong>Elavon User ID</strong> associated with your Elavon account.{/ts}</p>
 235 {/htxt}
 236 {htxt id='Elavon-test-signature'}
 237 <p>{ts}This is the TEST <strong>Elavon SSL PIN</strong> associated with your Elavon account.{/ts}</p>
 238 {/htxt}
 239 {htxt id='Elavon-test-url-site'}
 240 <p>{ts}Use 'https://www.myvirtualmerchant.com/VirtualMerchant/processxml.do' unless otherwise advised by Elavon.{/ts}</p>
 241 {/htxt}
 242
 243 {htxt id='FirstData-live-user-name'}
 244 <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>
 245 {/htxt}
 246 {htxt id='FirstData-live-password'}
 247 <p>{ts}This is the LIVE <strong>Certificate Path</strong> associated with your First Data account.{/ts}</p>
 248 {/htxt}
 249 {htxt id='FirstData-live-url-site'}
 250 <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>
 251 {/htxt}
 252 {htxt id='FirstData-test-user-name'}
 253 <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>
 254 {/htxt}
 255 {htxt id='FirstData-test-password'}
 256 <p>{ts}This is the TEST <strong>Certificate Path</strong> associated with your First Data account.{/ts}</p>
 257 {/htxt}
 258 {htxt id='FirstData-test-url-site'}
 259 <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>
 260 {/htxt}