Understanding the API Key lifecycle

Understanding the API Key lifecycle

API keys are unique identifiers used to authenticate access to Sandbox APIs. They verify the identity of the requesting application and ensure secure, reliable communication with Sandbox services. 

API Keys Lifecycle

Sandbox API keys can exist in the following states:

  • Active – The key is valid and can be used for making API requests.
  • Inactive – The key is disabled due to the absence of an active plan.
  • Halted – The key is temporarily disabled because the plan quota has been reached.

💡 Enable overdraft to continue using APIs after reaching the quota.

  • Restricted – The wallet balance is less than zero (negative), restricting access to certain API with additional charges.

💡 Learn how to add funds to your wallet.


Facing a problem? Create a ticket and we'll handle it from here.

    • Related Articles

    • Generate your API Keys

      API keys are essential for authenticating and authorising to access Sandbox APIs. How to Generate API Keys Log In to Console Account: Access your account by logging into the Console. Navigate to API Keys: Go to the Settings menu and Select API Keys ...

    • Configure a Webhook

      Configuring up a Webhook enables your application to receive live event notifications from Sandbox Console, allowing it to act on events in real-time. What You’ll Need A Webhook URL / Callback URL: The endpoint where live event data will be sent. ...

    • Types of Roles in Console

      Console offers role-based access control to ensure efficient management and security within your workspace. 1. Admin The Admin holds the highest level of access and overall control of the workspace. Permissions: Full access to all settings and ...

    • Edit your Workspace

      Keep your workspace up to date by editing its details. You can update the name, business information, address and configure additional setting to suit your needs. Steps to Edit Your Workspace Details Log In to Console: Access your account by logging ...

    • What is a Webhook?

      A Webhook is a mechanism that allows applications to send real-time notifications to other systems whenever specific events occur. Unlike traditional APIs that require polling (periodically checking for updates), webhooks automatically send data to a ...