Skip to content
Last updated

Get started with Kustom

This guide shows you how to integrate Kustom Checkout (KCO) to your e-commerce site. With just a handful of lines of code you can have a live checkout widget in minutes, and the overall effort required is low.

About the guide

This guide focuses on a direct KCO integration. If you’re using Magento, WooCommerce, or another supported platform, you can simplify the process further by installing one of our ready-made plugins or asking your platform provider for help. Read more about our partner integrations here

Get access to a test account

To get started integrating Kustom Checkout, create a Kustom Playground account in just a few steps:

  1. Go to the Playground onboarding page.
  2. Complete the Playground onboarding form by entering:
    • your store name, and
    • the email address you’d like associated with your account.
  3. Submit the form. You’ll receive a confirmation email containing a link to the Kustom Playground Portal.
  4. Open the link and choose your preferred sign-in method:
    • SSO: Microsoft or Google
    • Magic link

How it works

The integration uses four main steps:

  1. Create order: An API call to create the order, returning an HTML snippet for rendering the KCO checkout iframe.
  2. Render Checkout snippet: The merchant renders the KCO iframe on their website.
  3. Read order: After the user completes the checkout process, the merchant performs an API call to read the order, receiving an HTML snippet for order confirmation.
  4. Render confirmation snippet: The merchant renders the confirmation snippet on their confirmation page.

For server-side integrations only, use the Hosted Checkout Page integration pattern.

Preparation

This integration requires:

  • A website to embed the KCO snippet
  • A backend server to make HTTP requests to KCO

You'll need merchant credentials (Merchant ID and shared secret) to make API calls. Instructions for creating these are available on the test environment page. A step-by-step video is also available.

API endpoints

Kustom APIs are available through different base URLs relating to your location and interaction needs. To access these APIs, combine the base URL + endpoint, for example to "create an order" construct the URL to call like this: Base URL for environment + /payments/v1/authorizations/

Live (production)

  • https://api.kustom.co/

Testing (playground)

  • https://api.playground.kustom.co/
Important information

Klarna’s API endpoint (https://api.klarna.com/) will remain functional alongside Kustom’s own API endpoint until the 31st of March 2026.

Access to Kustom Portal

  • https://portal.kustom.co/ - Production
  • https://portal.playground.kustom.co/ - Playground

More about API Basics here

Help and support

For integration support, visit the support page.

 
Next page