Generating an API Key
How to Generate an API Key in the Portal?
API keys, both private and public, can be generated by any user type directly in the Payrix Pro portal by following these steps:
You can create a Sandbox API key by following these exact steps in the Sandbox Portal.
Generating an API Key in the Portal
Step 1 - Find the API Keys box on the Settings page
Scroll to the bottom of the Dashboard menu and select Settings.
From the Settings page, click API Keys.
Step 2 - Select “Add API Key”
On the API Keys page, click Add API Key.
Step 3 - Complete the Add API Key form
Complete the three fields:
Name: Enter a custom name for the new API key you are generating.
Status: From the dropdown menu, select whether you want the new API key to be active or inactive. You can always update the API key status after it is generated.
Type: From the dropdown menu, select whether you want to generate a private or public API key.
Click Add to generate the new API key.
Where to Find an API Key After It Has Been Generated
After generating the new API key, you can locate it on the same page where the rest of your API keys are listed and use the clipboard icon to copy it:
Use Case: Rolling API Key
A “rolling” API key is an additional security measure that can be taken to manually and periodically change the API key, making it extremely difficult to compromise. See the enablement steps below (after following the steps above for generating an API key):
To further limit access, use a dedicated user to create your API keys.
Using your private or master API key, create a new API key under your dedicated user.
Apply this API key to your PayFields setup.
Every 6 hours, create a new API key under that user, and update the PayFields.
Delete the previous API key 2 hours after you have updated the PayFields. Leaving the old key active for about 2 hours is recommended in case a user has the page opened, and the old key is cached there.