GET https://xquik.com/api/v1/credits/topup/status
Free. This endpoint does not consume credits.
Hold queued API work until checkout is paid
Store the checkout session ID when creating a standard top-up. Associate it with the intended tweet, follower, reply, monitor, or write workload. Never substitute a session from another account or purchase. Poll this endpoint before you start work that needs the credits. Act on the returned status.processingkeeps the workload paused.paidallows a fresh credit-balance check.failedrequires a new checkout.expiredrequires a new checkout.
amount_dollars or credits alone. Only paid
confirms that Xquik granted credits. Then call
Get Credits. Compare the balance with the planned
request cost.
Limit polls while the status is processing. Wait between requests and honor
Retry-After after rate limiting. Faster polling does not speed up
payment.
Store the last observed status and check time with the session ID. This lets
another worker resume polling without creating a second purchase.
failed and expired are final. Stop polling that session. Create a new checkout only
after the user or approved billing workflow requests it.
When paid appears, start only the workload tied to that checkout. Keep
unrelated queues behind their own credit and approval checks. One top-up
then cannot start unrelated work.Headers
Query parameters
Response
200 Paid
Payment succeeded. Xquik added credits to the account.200 Processing
Payment has not reached a final state yet. Poll again later.200 Failed
Payment failed. Create a new top-up checkout before retrying payment.200 Expired
The checkout session expired before payment completed.400 Invalid input
Thesession_id query parameter is missing.401 Unauthenticated
Missing or invalid API key.404 Not found
No top-up checkout exists for that session ID on this account.429 Rate limited
{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 }
Too many requests. Wait for the Retry-After header before retrying.Related. Top Up Credits · Quick Top-Up · Get Credits · Billing Guide
Response examples
- 400
{ "error": "invalid_input", "message": "Invalid input. Check the request body." } - 401
{ "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." } - 403
{ "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." } - 404
{ "error": "not_found", "message": "Resource not found." } - 429
{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }