Skip to main content
POST https://xquik.com/api/v1/guest-wallets Create a prepaid read wallet without an account, email address, or dashboard. This endpoint creates a one-use hosted checkout after the user confirms a USD amount. It does not charge the user.
Ask the user to confirm the amount before calling this endpoint. Give the returned checkout_url to the user. Never open, submit, or complete the payment for them.
Store both api_key and the original Idempotency-Key as secrets. An exact replay can return the same response, including the key. No email recovery is available. Give only checkout_url to the user. After payment, poll status_url every poll_after_seconds with the guest key. Stop when latest_purchase.status is no longer pending. Do not call paid reads until usable is true.

Headers

Body

Response

The response sends Cache-Control: no-store, private. An exact replay also sends Idempotent-Replayed: true.

Response examples

201 example

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 409 { "error": "idempotency_conflict", "message": "Reuse this Idempotency-Key only with the original request." }
  • 410 { "error": "checkout_unavailable", "message": "Checkout unavailable. Retry with a new Idempotency-Key." }
  • 413 { "error": "body_too_large", "message": "Request body is too large." }
  • 415 { "error": "unsupported_media_type", "message": "Send a Content-Type header of application/json." }
  • 423 { "error": "guest_wallet_unavailable", "message": "Guest wallet unavailable. Create a new wallet or contact support." }
  • 429 { "error": "rate_limited", "message": "Try again later." }
  • 503 { "error": "guest_wallets_unavailable", "message": "Guest wallet checkout is temporarily unavailable." }