Overview – Concepts
This article describes the steps needed to configure the “API Key” in Payment Processing Settings for Datacap-based Payment Processing Methods. This applies to DC Direct, and in some cases to NETePay & TranCloud.
First, make sure one of the above Processing Methods is selected.
If you’re using NETePay or TranCloud, your Datacap deployment might have been set up in one of two modes:
- Hosted Bridge mode – communicates with Datacap’s gateway; the gateway connects to processors.
- Classic mode – communicates directly with your payment processor’s network.
DC Direct always uses Hosted Bridge mode.
Artisan determines which mode you’re using by looking at your Merchant ID:
In Classic mode, you’ll use the actual Merchant ID from your processing company, or for TSYS, the “Host Capture POS ID” (a.k.a. “HC POS ID”), both of which are all-numeric.
In Hosted Bridge mode, the Merchant ID will be an alphanumeric Merchant ID provided by Datacap, which starts with the Datacap Deployment ID.
After you’ve entered your Merchant ID, enter your API Key in the next field:
NOTE: An API Key is required for all new or changed Payment Processing Profiles using Hosted Bridge mode, but will initially be blank for data older than Artisan 4.9.170. In that case, Artisan will continue to operate as before, without advanced communications error recovery, until you enter an API Key.
Obtaining a Datacap API Key
Whoever set up your Datacap deployment in preparation for integration with Artisan POS Software, will be able to obtain your API Key for you. This might be your Merchant Account Provider, an Artisan POS Dealer, or Artisan Tech Support. They can use one of the following methods:
The API Key (sometimes referred to be Datacap as a “Token Key”) is provided by Datacap, along with the Datacap Merchant ID, in the deployment order confirmation email.
The Token Key can also be found in the Datacap PSCS portal through View Deployments or Change Activated File, next to the Merchant ID:
Resetting Your API Key
When you save a new or changed Payment Processing Profile with an API Key, Artisan will connect to the Datacap server and generate an “API Token” (which Datacap sometimes calls the “API Key”). If that’s already been done, you’ll see this error:
To fix this, you must reset the API Key, and then save the Artisan Configuration Settings again. In the Datacap PSCS portal, choose Change Activated File and then select the appropriate Deployment. Underneath the Merchant ID / Token Key box, you’ll see a Reset API Key button:
After you press the Reset API Key button, you’ll have to go through a multi-step confirmation process, checking the “reset” checkbox, then typing “RESET” in the next box.
PSCS will respond with “API Key Reset Successful”.
NOTE: Resetting an API Key will invalidate any existing API Tokens for that Deployment. To force Artisan to generate a new token, copy the current API Key, then clear the API Key field. (You can use Cut – Ctrl-X to do this in one step.) Move off of the API Key field, then go back and paste the key back in. Save the Configuration Settings.