Start a checkout
Starts an agentic checkout. Pay with the built-in card (source: demo), or with a card already prepared for payment (source: card, plus its card_id). The built-in card is prepared before this call returns, so a card that cannot be prepared fails here with a 502; a card that has not yet been prepared for payment is rejected with a 409. A 409 also arises when a checkout is already in progress for the card; the two cases are told apart by the response error_code. Once started, the checkout is accepted (202) with a tracking identifier and the remaining payment steps continue asynchronously; follow the self link to track progress.
Authorizations
Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.
Headers
Tenant org ID for multi-tenant auth
Controls how timestamp fields are serialized in JSON response bodies.
Default (header omitted or any other value): epoch milliseconds as integers.
iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.
Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".
Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.
Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.
"iso8601"
Body
- DemoCheckoutSource
- CardCheckoutSource
Start a checkout using the built-in card.
"demo"Response
Card prepared; checkout accepted and continuing asynchronously.
Confirmation that a checkout has started.
HAL-style hypermedia links for navigation and available actions.
Identifier of the checkout to track its progress.
Checkout progress at acceptance — the same vocabulary the status endpoint returns: pending, tokenized, enrolled, or failed.