Documentation Index
Fetch the complete documentation index at: https://docs.xquik.com/llms.txt
Use this file to discover all available pages before exploring further.
Free - does not consume credits
Use this endpoint after creating a standard top-up checkout. Pass the checkout session ID for that top-up to check whether payment is complete.
curl "https://xquik.com/api/v1/credits/topup/status?session_id=checkout_session_id" \
-H "x-api-key: xq_YOUR_KEY_HERE" | jq
Your API key. Session cookie authentication is also supported.
Query parameters
Checkout session ID for the top-up checkout.
Response
200 Paid
200 Processing
200 Failed
200 Expired
400 Invalid input
401 Unauthenticated
404 Not found
429 Rate Limited
Payment succeeded. Credits have been added to the account.Dollar amount requested for the top-up.
Credit amount granted as a Bigint string.
{
"amount_dollars": 25,
"credits": "166666",
"status": "paid"
}
Payment has not reached a final state yet. Poll again later.Dollar amount requested for the top-up, when available.
Pending credit amount as a Bigint string, when available.
{
"amount_dollars": 25,
"credits": "166666",
"status": "processing"
}
Payment failed. Create a new top-up checkout before retrying payment. The checkout session expired before payment completed. { "error": "invalid_input" }
The session_id query parameter is missing.{ "error": "unauthenticated" }
Missing or invalid API key.No top-up checkout exists for that session ID on this account. { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 }
Too many requests. Wait for the Retry-After header before retrying.