Difference between revisions of "Accept.js by Authorize.net"

From WHMCS Documentation

(Payment Workflow)
(Migrating to Accept.js)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.3 and above.</div>
+
== About this Module ==
 +
 
 +
<div class="docs-alert-success">
 +
The WHMCS Official Accept.js by <nowiki>Authorize.net</nowiki> module was introduced in WHMCS 7.3.
 +
</div>
 +
 
 +
Accept.js is a tokenised gateway. As a result, Accept.js stores customers' submitted personal credit card information remotely. We recommend using a tokenised gateway for security and reduced liability.
 
{{gateways
 
{{gateways
 
| type = token
 
| type = token
Line 6: Line 12:
 
| updatecc = yes
 
| updatecc = yes
 
| deletecc = yes
 
| deletecc = yes
 +
| refunds = yes
 +
| AddPayMethod API = no
 
}}
 
}}
 +
== Adding the Accept.js by Authorize.net Payment Gateway ==
  
The WHMCS Official Accept.js by Authorize.net module was introduced in WHMCS 7.3.
+
To set up the Accept.js by Authorize.net payment gateway in WHMCS:
 +
 +
# Ensure that you have installed a valid SSL certificate for your site and have configured your system URL in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' (or '''Setup > General Settings''' prior to WHMCS 8.0) to [[Configuration|serve pages over SSL]]. Your system URL should begin with <tt>https</tt> and visitors should be able to navigate your site without security acceptance prompts.
 +
# Go to the appropriate location for your version of WHMCS:
 +
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
 +
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
 +
# Click '''Authorize.net Accept.js'''.
 +
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
 +
# Enter the '''API Login ID''' and '''Transaction Key''' values. You can find these in your Authorize.net account at '''Account > Security Settings > API Credentials & Keys'''.
 +
# Enter your '''Public Client Key''' value. You can find this in your Authorize.net account at '''Account > Security Settings > Manage Public Client Key'''.
 +
# Click '''Save Changes'''.
  
Accept.js is a tokenised gateway. As a result, customers personal credit card information is submitted to and stored remotely by Accept.js. Using a tokenised gateway is recommended for security and reduced liability.
+
<div class="docs-alert-danger">
 +
<span class="title">Warning</span><br />
 +
The Accept.js gateway module is not compatible with the ''Modern'' or ''Boxes'' order form templates.
 +
</div>
  
==Setup==
+
== Payment Workflow ==
# Ensure that you have installed a valid SSL certificate for your site and that your system URL in ''Setup >> General Settings'' is configured to serve pages over SSL.
 
#* Your system URL should begin with "https" and visitors should be able to navigate your site without security acceptance prompts.
 
# Begin by activating the '''Accept.js''' module in ''Setup > Payments > Payment Gateways''
 
# Accept.js uses API keys for authentication. Upon activation, you will be asked to enter the API Login ID, Transaction Key, and Public Client Key.
 
#* These can be found or generated inside the Authorize.net portal under ''Account > Security Settings > API Credentials & Keys''
 
# Customise the Display Name as desired, we recommend ''Accept by Authorize.net''
 
# Click '''Save Changes''' to complete the setup
 
  
Accept.js is now active and ready for use.
+
This workflow supports automated recurring and on-demand billing.  
  
<div class="docs-alert-warning">'''Warning:''' The Accept.js gateway module is not compatible with the Modern or Boxes order form templates.</div>
+
When they pay, customers can choose to use a previously-stored card or enter a new one and can update their card at any time from the client area. Admin level users with the necessary permissions can also perform card updates from the admin area.
  
==Payment Workflow==
+
* Within this workflow, customers never leave your WHMCS installation during checkout or when updating their card.
# Automated recurring and on-demand billing is supported.
+
* The system submits personal card information directly to Accept.js and never stores it on your local WHMCS installation.
# When making a payment, customers are able to select to use a previously stored card or enter a new one.
 
# Customers can update their credit card at any time from the client area.
 
# Admin level users with the necessary permissions can also perform card updates from the admin area.
 
# Customers never leave your WHMCS installation during checkout or updating their card.
 
# Personal card information is submitted directly to Accept.js and is never stored in your local WHMCS installation.
 
# The Accept.js API is used for obtaining transaction information.
 
# The Accept.js.js library is used for payments and card updates.
 
  
==Migrating to Accept.js==
+
The system uses the Accept.js API for obtaining transaction information, and uses the Accept.js.js library for payments and card updates.
  
Our Accept.js module supports migrating credit card details stored locally within WHMCS to the Accept.js tokenisation system.  This allows for a seamless transition from another merchant gateway provider to Accept.js.
+
== Migrating to Accept.js ==
  
Migration of existing clients' locally stored credit card data occurs during the next payment process per client. The first time a payment capture is attempted for an invoice using Accept.js, the credit card details will be submitted to Accept.js and a token created and stored. Any card details stored locally for that client will be removed.
+
Our Accept.js module supports migrating credit card details from WHMCS to the Accept.js tokenisation system. This allows for a seamless transition from another merchant gateway provider to Accept.js.
 +
 
 +
Migration of existing clients' locally-stored credit card data occurs during the next payment process for each client. The first time the system attempts a payment capture for an invoice using Accept.js, the system will submit credit card details to Accept.js and create and store a token. The system will remove any locally-stored card details for that client.
  
 
To migrate all of your credit card processing to Accept.js, follow the steps below:
 
To migrate all of your credit card processing to Accept.js, follow the steps below:
  
# Navigate to ''Setup > Payments > Payment Gateways''
+
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
# Ensure the Accept.js module has been activated
+
# Ensure that you have activated the Accept.js module. If you have not, go to the appropriate location for your version of WHMCS and activate it:
# Select the '''Deactivate''' link for your previous merchant gateway provider
+
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
# When prompted to choose a replacement gateway to switch users of the previous gateway module to, select Accept.js
+
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]'''.
# Click '''OK''' to complete the process
+
# Select the '''Deactivate''' link for your previous merchant gateway provider.
 +
# When the system prompts you, select ''Accept.js''.
 +
# Click '''OK''' to complete the process.
 +
 
 +
<div class="docs-alert-info">
 +
<span class="title">Note</span><br />
 +
The system will send existing locally-stored credit card details to Accept.js and convert them to a token the first time that the client attempts a payment using the Accept.js module. Until that time, locally-stored credit card details will remain within WHMCS.</div>
 +
 
 +
== Troubleshooting ==
  
<div class="docs-alert-info">'''Note:''' Existing credit card details stored locally will be sent to Accept.js and converted to a token the first time a payment is attempted for a client using the Accept.js module. Until that time, credit card details will remain stored locally within WHMCS.</div>
+
''N/A''

Latest revision as of 19:30, 28 September 2022

About this Module

The WHMCS Official Accept.js by Authorize.net module was introduced in WHMCS 7.3.

Accept.js is a tokenised gateway. As a result, Accept.js stores customers' submitted personal credit card information remotely. We recommend using a tokenised gateway for security and reduced liability.

Supported Features

Type One Time Recurring Refunds 3D Secure
Token Yes Yes Yes No
Remote Update Card Remote Delete Card AddPayMethod API
Yes Yes No

Adding the Accept.js by Authorize.net Payment Gateway

To set up the Accept.js by Authorize.net payment gateway in WHMCS:

  1. Ensure that you have installed a valid SSL certificate for your site and have configured your system URL in Configuration () > System Settings > General Settings (or Setup > General Settings prior to WHMCS 8.0) to serve pages over SSL. Your system URL should begin with https and visitors should be able to navigate your site without security acceptance prompts.
  2. Go to the appropriate location for your version of WHMCS:
    • For WHMCS 8.0 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
    • For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways and choose All Payment Gateways.
  3. Click Authorize.net Accept.js.
  4. Check Show on Order Form to display this payment method in the Client Area during checkout.
  5. Enter the API Login ID and Transaction Key values. You can find these in your Authorize.net account at Account > Security Settings > API Credentials & Keys.
  6. Enter your Public Client Key value. You can find this in your Authorize.net account at Account > Security Settings > Manage Public Client Key.
  7. Click Save Changes.

Warning
The Accept.js gateway module is not compatible with the Modern or Boxes order form templates.

Payment Workflow

This workflow supports automated recurring and on-demand billing.

When they pay, customers can choose to use a previously-stored card or enter a new one and can update their card at any time from the client area. Admin level users with the necessary permissions can also perform card updates from the admin area.

  • Within this workflow, customers never leave your WHMCS installation during checkout or when updating their card.
  • The system submits personal card information directly to Accept.js and never stores it on your local WHMCS installation.

The system uses the Accept.js API for obtaining transaction information, and uses the Accept.js.js library for payments and card updates.

Migrating to Accept.js

Our Accept.js module supports migrating credit card details from WHMCS to the Accept.js tokenisation system. This allows for a seamless transition from another merchant gateway provider to Accept.js.

Migration of existing clients' locally-stored credit card data occurs during the next payment process for each client. The first time the system attempts a payment capture for an invoice using Accept.js, the system will submit credit card details to Accept.js and create and store a token. The system will remove any locally-stored card details for that client.

To migrate all of your credit card processing to Accept.js, follow the steps below:

  1. Navigate to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.
  2. Ensure that you have activated the Accept.js module. If you have not, go to the appropriate location for your version of WHMCS and activate it:
    • For WHMCS 8.0 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
    • For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways.
  3. Select the Deactivate link for your previous merchant gateway provider.
  4. When the system prompts you, select Accept.js.
  5. Click OK to complete the process.

Note

The system will send existing locally-stored credit card details to Accept.js and convert them to a token the first time that the client attempts a payment using the Accept.js module. Until that time, locally-stored credit card details will remain within WHMCS.

Troubleshooting

N/A