PayLink

🔑 API Key Status API

This API allows you to check the status of your API key. It returns information such as whether the API key is active, the associated protocol, and other details.

Note:

Always include a valid api_key in the request headers. If the key is missing or invalid, you will receive a 404 Not Found response.

  • 🔹 This API requires an API Key for authentication.
  • 🔹 The API key must be sent via header and query parameters are no longer used.

💡 Example Request


GET https://paylink.digital/api/gateway/v1/apiStatus

Headers:
Authorization: Bearer <your_api_key>

🔍 Example Response


{
  "status": true,
  "statusCode": 200,
  "data": {
    "apiKeyStatus": "active"
  }
}

⚠️ Error Handling

The API may return the following error responses:


{
  "status": false,
  "statusCode": 400,
  "message": "Invalid or missing api_key header"
}

400 Bad Request: The api_key header is missing or invalid. Ensure a valid key is provided.


{
  "status": false,
  "statusCode": 404,
  "message": "API Key not found"
}

404 Not Found: The provided API key was not found. Double-check the key and try again.


{
  "status": false,
  "statusCode": 500,
  "message": "Internal server error"
}

500 Internal Server Error: An unexpected server error occurred. Try again later or contact support.

📖 Further Documentation