Documentation

Build with the BlockPay SDK.

A small, sharp surface for stablecoin checkout. The whole API fits on a postcard — and the postcard is below.

checkout.ts@blockpay/checkout

01import { Checkout } from "@blockpay/checkout";
02
03const checkout = new Checkout({
04  apiKey: process.env.BLOCKPAY_KEY,
05  settleTo: "0xA0b8…F1c2", chain: "base",
06});
07
08await checkout.createSession({ amount: 42 });

Where do you want to start?

Three doors into the docs. Each one ends at a working checkout.

Quick Start

Take your first stablecoin payment in five minutes. Install the SDK, paste your wallet address, render the checkout button.

Read the guide

API Reference

Every endpoint, request shape, response envelope and error code. Versioned, OpenAPI-described, batteries included.

Browse endpoints

SDK Reference

The complete @blockpay/checkout surface — invoices, payment links, signed receipts, and webhook verification helpers.

Open the SDK docs

Go deeper into the platform.

Once you have the basics, these are the most-read pages in our docs. Concepts first, then concrete recipes.

All docs

Webhooks

Subscribe to invoice.paid, payment.received, payment.refunded and more — every event signed with HMAC.

Shopify

A drop-in theme button, a Shopify App built on @blockpay/shopify, and the full webhook event reference.

WordPress

The official WooCommerce plugin, a custom WC_Payment_Gateway on blockpay/woocommerce, and a standalone PHP recipe.

Stuck? We'll unstick you.

Email us, ping the Discord, or open a GitHub issue. Average first-response time is under an hour during business windows.

Contact support Browse the docs