Skip to content

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.

  1. Order payload: cart items, amounts and callback URLs.
  2. Create an order: send the payload and store order_id.
  3. Render and update: display html_snippet and handle cart updates.
  4. Handle callbacks: choose which checks your server needs to make.
  5. Confirm the order: record and acknowledge the order from both confirmation and push.

After you prepare the payload, a purchase follows this sequence:

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.