Dashboard

🔍 Invoice Status API

The Invoice Status API allows you to retrieve the current status of a specific invoice. This API can return details such as the invoice status, amount, currency, protocol, and more.

Note:

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

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

💡 Example Request


GET /apiStatus?invoice_id=<invoice_id>

Headers:
Authorization: Bearer <your_api_key>

Query Parameters:
- invoice_id (required): The unique identifier of the invoice you wish to check.

🔍 Example Response


{
  "status": true,
  "statusCode": 200,
  "data": {
    "invoiceStatus": "paid",
    "amount": 1000,
    "symbol": "USDT",
    "protocol": "TRC20",
    "reference_id": "abc123",
    "created_at": "2025-02-16T12:00:00Z"
  }
}

⚠️ Error Handling

The API provides the following error responses:


{
  "status": false,
  "statusCode": 400,
  "message": "Invalid invoice_id parameter"
}

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


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

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


{
  "status": 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