Create Guest Wallet for Pay-per-request X API

{
  "account_required": false,
  "amount": {
    "amount_minor": 1000,
    "currency": "usd"
  },
  "api_key": "xq_example_returned_once",
  "authorization": {
    "header": "Authorization",
    "scheme": "Bearer"
  },
  "checkout_url": "https://checkout.example/guest/example",
  "credential_notice": "Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available.",
  "credits": "66666",
  "expires_at": "2026-07-13T13:00:00.000Z",
  "instructions": "Give checkout_url to the user. They must complete payment on the hosted checkout page. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.",
  "poll_after_seconds": 2
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "idempotency_conflict",
  "message": "Reuse this Idempotency-Key only with the original request."
}

{
  "error": "checkout_unavailable",
  "message": "Checkout unavailable. Retry with a new Idempotency-Key."
}

{
  "error": "body_too_large",
  "message": "Request body is too large."
}

{
  "error": "unsupported_media_type",
  "message": "Send Content-Type: application/json."
}

{
  "error": "guest_wallet_unavailable",
  "message": "Guest wallet unavailable. Create a new wallet or contact support."
}

{
  "error": "rate_limited",
  "message": "Try again later."
}

{
  "error": "guest_wallets_unavailable",
  "message": "Guest wallet checkout is temporarily unavailable."
}

POST

guest-wallets

Create Guest Wallet for Pay-per-request X API

curl --request POST \
  --url https://xquik.com/api/v1/guest-wallets \
  --header 'Content-Type: <content-type>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount_minor": 123,
  "currency": "<string>"
}
'

import requests

url = "https://xquik.com/api/v1/guest-wallets"

payload = {
    "amount_minor": 123,
    "currency": "<string>"
}
headers = {
    "Content-Type": "<content-type>",
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Content-Type': '<content-type>',
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>'
  },
  body: JSON.stringify({amount_minor: 123, currency: '<string>'})
};

fetch('https://xquik.com/api/v1/guest-wallets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/guest-wallets"

	payload := strings.NewReader("{\n  \"amount_minor\": 123,\n  \"currency\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "account_required": true,
  "amount": {},
  "checkout_url": "<string>",
  "api_key": "<string>",
  "authorization": {},
  "credential_notice": "<string>",
  "status_url": "<string>",
  "poll_after_seconds": 123,
  "requires_user_interaction": true,
  "instructions": "<string>",
  "purchase_id": "<string>",
  "status": "<string>",
  "expires_at": "<string>",
  "credits": "<string>",
  "wallet_id": "<string>"
}

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.

idempotency_key=$(uuidgen | tr '[:upper:]' '[:lower:]')
response=$(curl -sS -X POST https://xquik.com/api/v1/guest-wallets \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $idempotency_key" \
  -d '{"amount_minor": 1000, "currency": "usd"}')
api_key=$(jq -r '.api_key' <<<"$response")
checkout_url=$(jq -r '.checkout_url' <<<"$response")
wallet_id=$(jq -r '.wallet_id' <<<"$response")
# Store $api_key and $idempotency_key in your secret manager. Do not print them.
printf 'Created guest wallet %s. Open %s\n' "$wallet_id" "$checkout_url"

import { randomUUID } from "node:crypto";

const idempotencyKey = randomUUID();
const response = await fetch("https://xquik.com/api/v1/guest-wallets", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": idempotencyKey,
  },
  body: JSON.stringify({ amount_minor: 1000, currency: "usd" }),
});
const wallet = await response.json();
const apiKey = wallet.api_key;
// Store apiKey and idempotencyKey in your secret manager. Do not print them.
process.stdout.write(String(wallet.checkout_url) + "\n");

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

string

required

Must be application/json.

string

required

A cryptographically random UUID v4. Reuse it only for an exact retry of the same amount. Store it as a secret because it can recover the initial key.

Body

integer

required

Confirmed USD amount in cents. Minimum 1000 and maximum 25000.

string

required

Must be usd.

Response

boolean

Always false.

object

Confirmed amount in minor units and usd currency.

string

One-use hosted checkout URL for the user to open.

string

Guest key returned on initial creation and exact idempotent replay. Store it as a secret.

object

Required Bearer header and scheme.

string

One-time credential storage guidance.

string

API URL to poll with the guest key.

integer

Minimum polling delay. Always 2 for a pending purchase.

boolean

Always true.

string

Required user interaction and polling guidance.

string

Guest purchase ID.

string

Initial purchase status. Normally pending.

string

Pending checkout expiry. New checkouts expire after 60 minutes.

string

Credits to grant after verified payment.

string

Guest wallet ID.

{
  "account_required": false,
  "amount": { "amount_minor": 1000, "currency": "usd" },
  "api_key": "xq_example_returned_once",
  "authorization": { "header": "Authorization", "scheme": "Bearer" },
  "checkout_url": "https://checkout.example/guest/example",
  "credential_notice": "Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available.",
  "credits": "66666",
  "expires_at": "2026-07-13T13:00:00.000Z",
  "instructions": "Give checkout_url to the user. They must complete payment on the hosted checkout page. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.",
  "poll_after_seconds": 2,
  "purchase_id": "gp_example",
  "requires_user_interaction": true,
  "status": "pending",
  "status_url": "https://xquik.com/api/v1/guest-wallets/status",
  "wallet_id": "gw_example"
}

The same Idempotency-Key was used with a different amount or request. Generate a new UUID v4 after the user confirms the new request.

Reduce the request body, then retry with the same Idempotency-Key.

Send Content-Type: application/json.

Wait for Retry-After before retrying the same request.

Checkout is temporarily unavailable. Retry with the same Idempotency-Key.

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

{
  "account_required": false,
  "amount": {
    "amount_minor": 1000,
    "currency": "usd"
  },
  "api_key": "xq_example_returned_once",
  "authorization": {
    "header": "Authorization",
    "scheme": "Bearer"
  },
  "checkout_url": "https://checkout.example/guest/example",
  "credential_notice": "Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available.",
  "credits": "66666",
  "expires_at": "2026-07-13T13:00:00.000Z",
  "instructions": "Give checkout_url to the user. They must complete payment on the hosted checkout page. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.",
  "poll_after_seconds": 2
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "idempotency_conflict",
  "message": "Reuse this Idempotency-Key only with the original request."
}

{
  "error": "checkout_unavailable",
  "message": "Checkout unavailable. Retry with a new Idempotency-Key."
}

{
  "error": "body_too_large",
  "message": "Request body is too large."
}

{
  "error": "unsupported_media_type",
  "message": "Send Content-Type: application/json."
}

{
  "error": "guest_wallet_unavailable",
  "message": "Guest wallet unavailable. Create a new wallet or contact support."
}

{
  "error": "rate_limited",
  "message": "Try again later."
}

{
  "error": "guest_wallets_unavailable",
  "message": "Guest wallet checkout is temporarily unavailable."
}

Create Guest Wallet for Pay-per-request X API

curl --request POST \
  --url https://xquik.com/api/v1/guest-wallets \
  --header 'Content-Type: <content-type>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount_minor": 123,
  "currency": "<string>"
}
'

import requests

url = "https://xquik.com/api/v1/guest-wallets"

payload = {
    "amount_minor": 123,
    "currency": "<string>"
}
headers = {
    "Content-Type": "<content-type>",
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Content-Type': '<content-type>',
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>'
  },
  body: JSON.stringify({amount_minor: 123, currency: '<string>'})
};

fetch('https://xquik.com/api/v1/guest-wallets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/guest-wallets"

	payload := strings.NewReader("{\n  \"amount_minor\": 123,\n  \"currency\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "account_required": true,
  "amount": {},
  "checkout_url": "<string>",
  "api_key": "<string>",
  "authorization": {},
  "credential_notice": "<string>",
  "status_url": "<string>",
  "poll_after_seconds": 123,
  "requires_user_interaction": true,
  "instructions": "<string>",
  "purchase_id": "<string>",
  "status": "<string>",
  "expires_at": "<string>",
  "credits": "<string>",
  "wallet_id": "<string>"
}

Overview

X API

X Write

Trends

Radar

Account

API Keys

Guest Wallets

Credits

X Accounts

Monitors

Events

Webhooks

Draws

Extractions

Compose

Drafts

Styles

Support

Create Guest Wallet for Pay-per-request X API

Headers

Body

Response

​Headers

​Body

​Response

Headers

Body

Response