Introduction

This article describes how to generate a Simple Object Access Protocol (SOAP) Toolkit Application Programming Interface (API) security key using the Business Center. The SOAP Toolkit API security key is required to authenticate API requests submitted through the SOAP Toolkit integration method. This process applies to both the Test and Production Business Center environments. You will need access to your Merchant ID (MID) within the Business Center to complete this procedure.

Prerequisites

• Active Business Center account with access to Payment Configuration settings
• Valid Merchant ID (MID) configured in the Business Center
• Appropriate permissions to generate API keys

Steps to Generate a SOAP Toolkit API Security Key

Follow the steps below to generate your SOAP Toolkit API security key in the Business Center.

1. Sign in to the Business Center environment where you will submit transactions (Test or Production).
2. Select Payment Configuration > Key Management from the navigation pane to display all API keys available for your Merchant ID.
3. Select GENERATE KEY.
4. Select SOAP Toolkit for the Key Type.
5. Select GENERATE KEY.
6. Read the instructions and download the key.
7. Save the displayed .txt file, which contains the SOAP Toolkit API security key, to the appropriate location on your system or server.

Potential Client Questions

• Which environment should I use to generate my SOAP Toolkit API security key - Test or Production?
  • Generate your key in the environment where you intend to submit transactions. Use the Test environment for development and integration testing, and use the Production environment when you are ready to process live transactions.
• Where should I save the downloaded .txt file containing the API security key?
  • Save the .txt file to a secure location on your system or server that your SOAP Toolkit integration can access. The specific location depends on your server configuration and integration setup.
• What happens if I generate a new SOAP Toolkit API security key - will my existing key stop working?
  • Generating a new key will replace your existing key. Update your integration with the new key promptly to avoid disruption to transaction processing.
• I do not see the Key Management option in my navigation pane. What should I do?
  • Verify that your Business Center user account has the appropriate permissions to access Payment Configuration settings. Contact your account administrator if the option is not visible.
• Can I use the same SOAP Toolkit API security key for both the Test and Production environments?
  • No. Keys are environment-specific. You must generate a separate key in each environment where you submit transactions.