Hex Pay Docs
API Reference

Retrieve payment status

Returns only the current status of a payment. Use this lightweight endpoint for high-frequency polling where you only need to detect status changes without the overhead of fetching the full payment object.

GET
/v1/payments/{paymentId}/status
AuthorizationBearer <token>

JWT token signed with the EdDSA algorithm. Obtain the token from the HexPay merchant dashboard and pass it via the Authorization: Bearer <token> header.

In: header

Path Parameters

paymentIdstring

Unique identifier of the payment (UUID).

Formatuuid

Response Body

curl -X GET "https://api.hexpay.io/v1/payments/019327c6-2058-7901-b234-56789abcdeff/status"

{
  "status": "created"
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "paymentId must be a valid UUID",
    "code": "invalid_payment_id",
    "param": "paymentId"
  }
}

{
  "error": {
    "type": "authentication_error",
    "message": "Missing authorization token",
    "code": "auth_missing"
  }
}

{
  "error": {
    "type": "not_found_error",
    "message": "Payment not found",
    "code": "payment_not_found"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "Internal server error",
    "code": "internal_error"
  }
}