Security Keys Settings
Security Keys are required if you use the 3-Step API or QuickClick. These keys authenticate transactions coming from your integration and tie activity back to a specific user in your Gateway reporting.
What Security Keys Are Used For
- API: typically used for the 3-Step Redirect API
- Cart: used for QuickClick
- You can enable one or both, depending on how you process payments
Each key includes:
- A Key ID
- A 32-character Security Key
- The user it is assigned to
- The transaction sources it supports (API, Cart, or both)
Create a Security Key
- Go to Security Keys Settings in the Gateway
- Enter a name for the key (example: “Default”)
- Select the user the key should be assigned to
- Choose what the key can authenticate: API, Cart, or both
- Click Generate New Key
After the page refreshes, your new key will appear in the list with the Key ID and Security Key value.
Using the Key
- The Security Key (32 characters) is used for the 3-Step API
- Depending on your QuickClick setup, you may also need the Key ID
- Transactions processed with a key will show in reporting under the user assigned to that key
Managing Keys
- You can create multiple keys for different users or different integrations
- You can delete a key at any time if it is no longer needed
Video Walkthrough
Watch the video below for a walkthrough of creating, assigning, and managing Security Keys for API and QuickClick use: