API Keys

Prev Next

The API Keys page contains a list of all API keys saved to your account and allows you to add a new API key or remove a saved key. An API Key is an authentication method that validates a user that is sending data to platform API (including both Merchant and other users).

To access the API Keys page:

  1. Click Settings in the left navigation panel.

  2. In the Business Settings section of the Settings page, click API Keys.

Tip

For more information on API keys, including how to set up an API key, access Authentication Methods in the Worldpay Developer Hub.

API Keys Table

The API Keys table contains a list of all API Keys saved to your account, and includes the following information:

  • Name: The name of the API key.

  • Key: The alphanumeric key sequence.

  • Created: The date that the key was created.

  • Active: Indicates whether the key is active.

  • Public: Indicates whether this is a public or private key.

  • Remove: To delete a key from your account, click the X icon to open the Delete a Key dialog. Cick CONFIRM to remove the key.

Add API Key

To add a new API Key to your account:

  1. Click the ADD API KEY button to open the Add API Key section.

  2. Enter the name of the new API Key.

  3. Set the API key status using the Status dropdown menu. Choose Active or Inactive.

  4. Set the type of key using the Type dropdown menu. Choose from Public or Private.

  5. Click ADD to save your new API Key and add it to the API Keys table.

Related pages

Click the items on the page or the links below to access any of the following pages: