- Checkout
- Get started
Integration overview
Build an embedded Kustom Checkout in five steps, from the order payload to payment confirmation. See the API calls between your server, browser and Kustom.
Using an e-commerce platform? Check for a plugin first. This guide is for developers building a custom integration.
You’ll need Playground credentials and a server with public HTTPS callback endpoints. To try the flow before building, use the quickstart.
Build the checkout
Section titled “Build the checkout”- Order payload: cart items, amounts and callback URLs.
- Create an order: send the payload and store
order_id. - Render and update: display
html_snippetand handle cart updates. - Handle callbacks: choose which checks your server needs to make.
- Confirm the order: record and acknowledge the order from both confirmation and push.
Purchase flow
Section titled “Purchase flow”After you prepare the payload, a purchase follows this sequence:
- Create an orderSend the cart and receive order_id and html_snippet.Your server → KustomPOST/
checkout/ keep API credentials on your serverv3/ orders Kustom → Your serverorder_id + html_snippet - Render the snippetDisplay html_snippet on your checkout page.Your server → Customer's browserhtml_snippetCustomer's browser → Kustomthe checkout iframeKustom collects the payment details
- Validate optionalCheck the order before the purchase completes.Kustom → Your serverPOSTyour validation URLreturn 200 to approve
- Confirm and pushRead, record and acknowledge the completed order.Kustom → Customer's browserredirect: your confirmation pageKustom → Your serverPOSTyour push URLhandle either route independently and idempotentlyYour server → KustomPOSTacknowledgestops the push retries
For hosted checkout or a native app, see integration models and the mobile SDK. See order lifecycle for order statuses.
This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.