Checkouts
Cancel a checkout
Stops the buyer from paying. If a payment already cleared before the cancel call lands, it still completes: cancelling doesn't reach into the card processor or on-chain state after the fact. Only works while the checkout is open (400 otherwise).
post/gateway/sessions/{sessionId}/cancel
Request
- Base URL: https://api.agentaos.ai/api/v1
- URL: https://api.agentaos.ai/api/v1/gateway/sessions/{sessionId}/cancel
- Auth: API key in header x-api-key
Path parameters
sessionIdstring required
The public session_id (not the internal id UUID).
Response
The checkout was cancelled.
Changes
No recorded changes to this operation across all 1 revision of this API.