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 who is sending data to the Payrix Pro API, including both Merchant and Partner 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 Features

Click here to view the features of the API Keys page.

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 alpha-numeric key sequence.

  • Created: The date and time that the key was created.

  • Active: Indicates whether the key is active. Select this checkbox to activate the API key.

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

  • Remove: To delete a key from your account, click the X icon to open the Remove dialog. Click CONFIRM to confirm the key deletion.

Add API Key Button

The Add API Key button is located in the top right corner of the page.

To add a new API Key to your account:

  1. Click the ADD API KEY button to open the Add API Key section at the top of the page.

  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 Public or Private.

  5. Save your new key by clicking Add.

  6. The new API Key will now appear in the API Keys table, with the API Key alphanumeric code in the Key column.

Related pages

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