Start or resume a page checkout intent

post

https://api.scalev.com/v3/pages/{page_unique_id}/checkout-intents

Use the published MainForm widget ID, or html-mode-main-form for a published HTML Mode page with checkout form context. The page public API key must match the path page. Requires a reCAPTCHA token for action checkout_intent_start. Repeating client_session_id resumes the unfinished attempt without replacing saved snapshots; PATCH with last_sequence + 1 to save new input. A completed session returns 409; create a new client_session_id after checkout succeeds. A valid optional cip_ prefill token resumes its matching unfinished attempt; invalid or mismatched prefill tokens fall back to the client session. Capture failures must not block checkout.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

page_unique_id

string

required

Public page unique ID.

Body Params

recaptcha_token

string

required

length ≥ 1

reCAPTCHA token for action checkout_intent_start.

client_session_id

uuid

required

Browser-persistent random UUID scoped to the page or storefront checkout; not a guest-cart token.

checkout_intent_prefill_token

string

Optional cip recovery capability. Invalid or mismatched tokens fall back to clientsession_id.

form_widget_id

string

required

length between 1 and 200

ID of a MainForm in the current published page, or html-mode-main-form for eligible HTML Mode checkout pages.

fields

object

items

array of objects

length ≤ 100

items

attribution

object

source_url

uri | null

Current checkout URL. Sensitive query parameters and fragments are stripped. Recovery links are only issued for trusted source origins.

cart_id

integer | null

≥ 1

Headers

X-Scalev-Page-Api-Key

string

required

Publishable page public API key for the page_unique_id path page. Storefront public API keys are not accepted on page-scoped public routes.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201New or resumed checkout intent and write capability.

400Malformed request.

403Checkout intent is not included in the active business subscription, or authorization failed.

404Source API key is missing or invalid, source was not found, or checkout intent does not belong to this source.

409The checkout intent is completed.

422Invalid capture fields, item references, sequence, form widget, or reCAPTCHA assessment.