Installation

Add SuiOutKit to your storefront - no backend to deploy.

Overview

SuiOutKit is a drop-in checkout SDK for Sui merchants. Install the npm package, pass your merchant address, and open the modal - fiat (bank transfer, OPay, cards) and crypto payments in one integration.

Stop stitching payment providers together. SuiOutKit is a single SDK that brings checkout, settlement, and receipts into one integration.

No server setup required: merchants only install the SDK - the hosted API (https://api.suioutkit.xyz, routes /v1/) handles sessions, webhooks, and settlement.

Prerequisites

  • Node.js 18+ for your storefront or app build
  • A merchant Sui address to receive settlement
  • HTTPS on your production site (recommended)

Install the SDK

npm install suioutkit

Configure

import { SuiOutKit } from "suioutkit";

const sdk = new SuiOutKit({
  merchantAddress: "0xYOUR_MERCHANT_SUI_ADDRESS",
});

The SDK handles API calls for you. For endpoint details see How It Works and the SDK Reference.

Running your own API (not required)

Merchant integration does not include running the SuiOutKit backend. Platform operators and contributors should see Hosted API and Developer Guide - separate from adding checkout to your site.

Next steps