Subscribe

Changed on

Create a hosted checkout only after the user confirms. The request never completes payment or adds credits.

post/api/v1/credits/topup

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/credits/topup
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

dollarsinteger required

Amount to top up in US dollars. Minimum 10.

localestring

Optional site language for Stripe's return page. An unsupported language uses en, the default.

Example request

{
  "dollars": 10,
  "locale": "en"
}

Response

Top-up checkouts

redirect_urlstring uri required

Stable Xquik redirect URL for the active checkout.

urlstring uri required

Same stable Xquik redirect URL as redirect_url. The response never exposes the hosted checkout URL.

Example response

{
  "redirect_url": "https://xquik.com/api/v1/credits/topup/redirect?session_id=checkout_example",
  "url": "https://xquik.com/api/v1/credits/topup/redirect?session_id=checkout_example"
}

Changes

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status