Skip to content
ReadyZone Docs
API Reference

Recover credentials

Recover guest credentials from notification contact or payment phone.

GET /api/payments/guest/active-credentials

Access : Public (rate-limited)

Operator use case

User paid but lost credentials: retrieve access without opening support ticket.

Parameters

  • notificationContact (query, optional)
  • paymentPhone (query, optional)

At least one of the two parameters must be provided. Values are matched against the notification contact or the phone used for the guest payment.

Response body

{
  "items": [
    {
      "username": "AA:BB:CC:DD:EE:FF",
      "password": "********",
      "status": "complete",
      "purchaseDate": "2026-03-12T08:20:00.000Z"
    }
  ]
}
AttributeTypeDescription
itemsarrayMatching guest purchases.
items[].usernamestringWi-Fi username.
items[].passwordstringPassword or masked value depending on the response.
items[].statusstringPurchase state, including complete, pending, or processing.
items[].purchaseDatestring (ISO 8601)Purchase date.

The portal may call this endpoint after payment confirmation and retry while credentials are being generated.

Status codes

  • 200 OK
  • 400 Bad Request
  • 429 Too Many Requests

On this page