Guest Wallets

Get guest wallet and payment status

Changed on

Poll after payment. Use usable to decide whether paid reads can run. An active wallet can remain usable while a top-up is pending. A new wallet becomes usable only after Xquik verifies payment. Send the guest key as Authorization: Bearer xq_...

get/guest-wallets/status

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/guest-wallets/status
  • Auth: API key in header x-api-key

Response

Guest wallet status without exposing the API key.

balancestring required
poll_after_seconds2 nullable required

Polling delay while payment is pending. Null means stop.

scope'paid_reads' required
status'active' | 'pending' | 'expired' | 'failed' | 'frozen' | 'closed' required

Combined wallet and pending-checkout state. A pending top-up can coexist with usable true. Terminal expired or failed states require a new guest wallet.

usableboolean required

Whether paid reads can run. Use it instead of status.

wallet_idstring required

Example response

{
  "balance": "66666",
  "latest_purchase": {
    "amount": {
      "amount_minor": 1000
    },
    "checkout_url": "https://checkout.xquik.com/session/example",
    "credits": "66666",
    "expires_at": "2026-07-13T13:00:00.000Z",
    "purchase_id": "gp_example",
    "status": "paid"
  },
  "poll_after_seconds": 2,
  "status": "active",
  "top_up": {
    "method": "POST",
    "path": "/api/v1/guest-wallets/topups"
  },
  "usable": true,
  "wallet_id": "gw_example"
}

Changes

  • 245194cd4ea7Revision changes
    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

  • dea38c0d032dRevision changes
    • warning

      added the new x_video_too_large enum value to the / response property for the response status

    • warning

      added the new x_video_too_large enum value to the / response property for the response status

    • warning

      added the new x_video_too_large enum value to the // response property for the response status

    • warning

      added the new x_video_too_large enum value to the // response property for the response status