POST /checkout/sessions — Create a Checkout Session

Creates a Blockra-hosted checkout session and returns a URL to redirect your buyer to. On the hosted page the buyer picks which coin to pay with, sees the deposit address and exact amount, and is sent to your success_url once the payment confirms. Requires the payments:write scope.

Request

POST https://api.blockra.io/checkout/sessions

Body parameters

amount

number

required

The amount to charge, in fiat. Blockra locks the live exchange rate once the buyer picks a coin. Example: 9.99.

currency

string

default:"USD"

The fiat currency to price in. One of USD, EUR, or GBP. Defaults to your account’s settlement currency.

label

string

A short description shown on the checkout page (max 255 characters).

reference

string

Your own order or reference ID (max 255 characters). Echoed back on the resulting payment and in webhook payloads.

customer_email

string

Pre-fills the buyer’s email and associates the payment with a customer record.

success_url

string

URL to redirect the buyer to after a successful payment. Falls back to your checkout settings when omitted.

cancel_url

string

URL to redirect the buyer to if they cancel. Falls back to your checkout settings when omitted.

Response

Returns a 201 with the session ID and the hosted checkout URL. Redirect your buyer to url.

string

The checkout session ID, prefixed cs_.

url

string

The hosted checkout page URL — redirect your buyer here.

curl https://api.blockra.io/checkout/sessions \
  -X POST \
  -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 9.99,
    "currency": "USD",
    "reference": "order_1234",
    "success_url": "https://your-site.com/thanks",
    "cancel_url": "https://your-site.com/cart"
  }'

const res = await fetch("https://api.blockra.io/checkout/sessions", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.BLOCKRA_API_KEY!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    amount: 9.99,
    currency: "USD",
    reference: "order_1234",
    success_url: "https://your-site.com/thanks",
    cancel_url: "https://your-site.com/cart",
  }),
});
const { data } = await res.json();
// redirect the buyer to data.url

{
  "data": {
    "id": "cs_a1b2c3d4e5f6g7h8i9j0k1l2",
    "url": "https://checkout.blockra.io/cs_a1b2c3d4e5f6g7h8i9j0k1l2"
  },
  "error": null
}

List CustomersRetrieve a paginated, filterable list of the customers who have paid you. Filter by email, order count, total spent, and date. Requires customers:read.

curl https://api.blockra.io/checkout/sessions \
  -X POST \
  -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 9.99,
    "currency": "USD",
    "reference": "order_1234",
    "success_url": "https://your-site.com/thanks",
    "cancel_url": "https://your-site.com/cart"
  }'

const res = await fetch("https://api.blockra.io/checkout/sessions", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.BLOCKRA_API_KEY!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    amount: 9.99,
    currency: "USD",
    reference: "order_1234",
    success_url: "https://your-site.com/thanks",
    cancel_url: "https://your-site.com/cart",
  }),
});
const { data } = await res.json();
// redirect the buyer to data.url

{
  "data": {
    "id": "cs_a1b2c3d4e5f6g7h8i9j0k1l2",
    "url": "https://checkout.blockra.io/cs_a1b2c3d4e5f6g7h8i9j0k1l2"
  },
  "error": null
}

​Request

​Body parameters

​Response

Request

Body parameters

Response