Quickstart

Use your sk_test_… key to follow this on testnets, where nothing can cost you anything. Everything below is identical in production — you change the key, not the URL. See Environments. No account yet? Get one.

1. Create a session

Server-side, with your secret key. This bills the payer 10 USDC on Base.

import { createCheckout } from "@hypermid/sdk";

const session = await createCheckout(
  {
    chain: 8453,
    token: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    amount: "10000000",           // 10 USDC — base units, as a string
    recipient: "0xYourTreasuryAddress",
    orderId: "order_1029",        // also the idempotency key
  },
  { secretKey: process.env.HYPERMID_SECRET_KEY! },
);

The SDK returns the session directly:

{
  "id": "co_01J…",
  "url": "https://pay.hypermid.io/pay/co_01J…",
  "status": "created",
  "mode": "checkout",
  "created": true
}

created: false means this was an idempotent replay — a session with that orderId already existed, and you get a 200 instead of a 201. Branch on it to avoid emailing a customer twice.

2. Send the payer to `url`

Redirect, or embed it. The payer picks any token they hold on any supported chain; you still receive exactly the token and chain you asked for.

3. Learn the outcome

Poll the session from your server, or register a webhook:

import { getPayment } from "@hypermid/sdk";

const session = await getPayment("co_01J…", {
  secretKey: process.env.HYPERMID_SECRET_KEY!,
});

Treat a webhook as a trigger, not as evidence. Read the session back before releasing goods — that read is the authoritative answer, and it is the one that survives a replayed or spoofed delivery.

Get started

Payments

Concepts

Webhooks

Resources

1. Create a session

2. Send the payer to `url`

3. Learn the outcome

​1. Create a session

​2. Send the payer to url

​3. Learn the outcome

1. Create a session

2. Send the payer to `url`

3. Learn the outcome