PayLink

🏢 Merchant Status API

The Merchant Status API allows you to retrieve the current status of a specific merchant. This API can return details such as the merchant's status and protocol.

Note:

Ensure that you pass a valid merchant_id when making a request. If the merchant does not exist or is not found, you will receive a 404 Not Found error.

  • 🔹 The API requires an API Key for authentication.
  • 🔹 The merchant_id should be passed as a query parameter in the request.

💡 Example Request


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

Headers:
Authorization: Bearer <your_api_key>
merchant_id: <your_merchant_id>

🔍 Example Response


{
  "success": true,
  "statusCode": 200,
  "data": {
    "merchantStatus": "active"
  }
}

⚠️ Error Handling

The API provides the following error responses:


{
  "success": false,
  "statusCode": 400,
  "message": "Invalid merchant_id parameter"
}

400 Bad Request: The merchant_id parameter is invalid. Ensure the correct ID format is used.


{
  "success": false,
  "statusCode": 404,
  "message": "Merchant not found"
}

404 Not Found: The merchant with the provided ID does not exist in the system. Double-check the merchant ID.


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

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

📖 Further Documentation