d5855df0e349

latestOpenAPI 3.1.02026-08-12128104480.9 KB
Guest Wallets

Create an accountless prepaid wallet checkout

Create a one-use hosted checkout after the user confirms $10-$250 USD. The request creates no charge. It returns a paid-read API key without an Xquik account. Idempotent replays return the same key.

post/guest-wallets

Headers

Idempotency-Keystring required

Generate a cryptographically random UUID v4. Reuse it only to retry the same wallet and amount request. Initial wallet creation can recover the API key from this value, so store it as a secret and never log it.

Request body

amount_minorinteger required

USD cents accepted for this checkout.

currency'usd' required

Example request

{
  "amount_minor": 1000
}

Response

Hosted checkout, guest API key, and API status URL.

account_requiredfalse required
api_keystring password required

Paid-read bearer credential returned only by initial creation. Store it as a secret. Never place it in a URL or log.

checkout_urlstring uri required

Hosted checkout URL for user interaction.

creditsstring required

Credits granted after verified payment.

credential_notice'Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available.' required
expires_atstring date-time required

Time when the pending checkout expires.

instructionsstring required

Hosted checkout and status polling instructions.

poll_after_seconds2 required

Wait at least this long before polling status_url.

purchase_idstring required
requires_user_interactiontrue required
status'creating' | 'pending' | 'paid' | 'expired' | 'failed' | 'refunded' | 'disputed' required
status_url'https://xquik.com/api/v1/guest-wallets/status' uri required
wallet_idstring required

Example response

{
  "amount": {
    "amount_minor": 1000
  },
  "api_key": "xq_example_returned_once",
  "authorization": {
    "header": "Authorization",
    "scheme": "Bearer"
  },
  "checkout_url": "https://checkout.example/guest/example",
  "credits": "66666",
  "expires_at": "2026-07-13T13:00:00.000Z",
  "purchase_id": "gp_example",
  "status": "pending",
  "wallet_id": "gw_example"
}