API health

Returns service availability, version and timestamp.

Access tierpublicRate limitpublicIdempotencynoneAuthenticationPublic

SourceLuxApi/app/Http/Controllers/Api/WalletApiController.php::healthLuxPayProjects @ 146e98baa44e

Parameters

X-Request-IDheader

stringOptional

Client correlation identifier. LuxPay may generate one when omitted.

Example: req_01J...

The displayed sandbox host is a placeholder until an official host is provisioned. Never paste a production token into a public browser.

curl --request GET \
  --url 'https://sandbox-api.luxpay.example/v1/health' \
  --header 'Accept: application/json'

200Successful response.

{
  "$ref": "#/components/schemas/Health"
}

{
  "status": "ok",
  "service": "luxpay",
  "version": "1.0.0",
  "timestamp": "2026-07-16T12:00:00Z"
}

400

401

403

404

409

422

429

500