View and edit all of the different sources that connect to your console from your API Keys Settings page, along with each API key’s status, PIN, and transaction result. These sources include all internal and external system sources such as POS systems, shopping carts, eStore or payment forms. To access your API Keys, click on ‘Settings’ from menu side bar, the select ‘API Keys’ on the drop down menu.
An API Key determines the source of the transaction. Each API key is assigned a unique key used to identify the source of each transaction when it is processed through the gateway.
Rearrange Your Table
Your API Keys home page displays a list of your API Keys with the following details:
- API Key
- Status: Disabled or Test Mode
- Duplicate Transaction Handling Status: Fold duplicate if ALL transaction data matches (F), None (N), Fold duplicate if card # and amount matches (M), Fold duplicate if card #, amount, order ID, and source matches (O)
By Default, your API Keys are arrange by name in alphabetical order. If desired, you can rearrange this table by the name of the API Key, API unique key, status, PIN, or the Duplicate Transaction Handling status. As an example, to rearrange the table by the Duplicate Transaction Handling, click on ‘Dupe Folding’ at the top bar of the table. See image below.
Add A New API Key
To add an API key, click
The window shown below will appear:
Descriptions of each field/setting are shown here. Adjust settings to fit your needs.
- Name - Enter the name of your source. We recommend that you use something descriptive and easy to remember. This field is required.
- PIN - This is optional. Enter the PIN number, if any.
- Currency - If you prefer to use a default currency for the API key, select the currency type in the drop down menu. Otherwise, select ‘No Default Currency’.
- Disabled or Test Mode - Check the box ‘Disabled’ if you want the API key to be disabled. Check the ‘Test Mode’ box if you want the API key to run on test mode.
- Allowed Commands - Select the commands the API key will be permitted to process. Your allowed commands should be based on who will be using the source, how public it is, and the specific fraud modules you plan to add. Available commands: Sale, Auth Only, Check Sale, Cash Sale, Credit, Post Auth, Check Credit, Cash Credit, Void, Capture, and Payment Form.
- Payment Methods - Select the payment methods the API key will be permitted to process. Available Payment Methods: Visa, Discover, MasterCard, Diners, JCB, American Express, and e-Check.
- Allowed IP’s - Enter a whitelist of the allowed IP addresses, with each IP address on its own line. To allow all IP addresses, leave the field blank.
- Duplicate Transaction Handling - This setting allows you to prevent fraud by catching similar or identical transactions occurring within a set period of time. Note: If you are using the Duplicate Detection fraud module, select ‘None’ on the drop down menu.
- Time Limit - Enter the time limit in minutes.
- Transaction Timeout - Enter the number of seconds for when the transaction times out
- Expired Authorizations - Select from the drop down menu on what actions to take for expired authorizations.
Please Note: The API Key will automatically be generated by the system once you have completed filling the information and click or
View An API Key’s Settings
To view and edit a API Key’s information or settings, click on the API key on your table.
You will be taken to that API Keys page where you can configure that API key’s settings.
Click or to save the changes you have made.
To delete the API, click
Click to return to your API Keys homepage.