The Integrations page allows you to manage your API keys, which are crucial for authenticating and interacting with Revaly’s services. From this page, you can generate new API keys for both Production and Sandbox environments, view existing ones, and delete keys that are no longer needed. These keys ensure your integration with Revaly remains secure and functional. If a key is missing or incorrect, you will receive a 401 authentication error, indicating that the request was not properly authorized.

Create API key

You can generate two types of API keys: Legacy Revaly keys for existing integrations, and Revaly v2.0 keys for new implementations using the latest API version.

As an Account Administrator, you can add keys directly from the Client Portal:

1. Log in to the Portal and navigate to Account Settings > Integrations
2. Click Generate API key or Generate Revaly API key
3. Enter a name for the key, select the Company to associate with it, and choose the environment mode.
   1. For more details on testing with Revaly, refer to our Sandbox Guide.
4. Click Generate.

A unique API key will be generated. Be sure to save it in a secure location immediately after it's created. Once you close the window, you will no longer be able to retrieve the key from the portal. Use the Copy icon to save it to your clipboard before closing.

📘

Note

If using the Gateway Management API, a Sandbox key will only be able to create gateways in that Mode. Any transactions sent to a sandbox gateway will never reach a production endpoint. For more information, please refer to our API documentation.

Delete API key

If you need to delete a key from your account, please follow these steps:

1. Log in to the Client Portal and navigate to Account Settings > Integrations.
2. Find the API key, then click the three dots on the right side of the screen to open the options menu and select Delete API key.
3. In the confirmation screen, toggle the option "I confirm permanent deletion of this Revaly API Key", then click Delete Revaly API key.

Once an API key is deleted, any transactions sent using that key will fail and return a 401 authentication error.

Scheduler

If your account has been configured to leverage Revaly's scheduler (see Enterprise with Scheduler Integration), the "Scheduler" tab will also be available in the Integrations section.

Please note that Scheduler can only be enabled once per Company/Environment combination. This means that if you only have the Default Company set up in your account, you'll be able to add the scheduler twice, one for Production and one for Sandbox.

To configure it, simply click Add Scheduler integration. In the new window, enter a name, and select a company, environment, and status. Click Add Scheduler integration.

🚧

Important

As soon as the Scheduler is enabled for a company, any transaction sent will be automatically scheduled and retried by Revaly. Do not enable it if your CRM is also scheduling and processing retries.