Get top-up status

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

Headers

x-api-key

string

required

Your API key. Session cookie authentication is also supported.

Query parameters

session_id

string

required

Checkout session ID for the top-up checkout.

Response

Payment succeeded. Credits have been added to the account.

status

string

Always "paid".

amount_dollars

integer

Dollar amount requested for the top-up.

credits

string

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.

status

string

Always "processing".

amount_dollars

integer

Dollar amount requested for the top-up, when available.

credits

string

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.

status

string

Always "failed".

{
  "status": "failed"
}

The checkout session expired before payment completed.

status

string

Always "expired".

{
  "status": "expired"
}

{ "error": "invalid_input" }

The session_id query parameter is missing.

{ "error": "unauthenticated" }

Missing or invalid API key.

{ "error": "not_found" }

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.

Related: Top Up Credits · Quick Top-Up · Get Credits · Billing Guide

​Headers

​Query parameters

​Response

Headers

Query parameters

Response