buildPaymentRequiredResponse

buildPaymentRequiredResponse(params): X402PaymentRequiredResponse

Defined in: src/x402/payment-requirements.ts:237

Builds the full X402PaymentRequiredResponse body the server returns alongside HTTP 402.

Parameters

params

BuildPaymentRequiredResponseParams

Returns

X402PaymentRequiredResponse

Example

import {
  buildPaymentRequiredResponse,
  buildPaymentRequirements,
  encodePaymentRequiredHeader,
  polygonAmoy,
} from "kawasekit";

const response = buildPaymentRequiredResponse({
  resource: { url: "https://api.example.com/weather", description: "Real-time weather" },
  accepts: [
    buildPaymentRequirements({ chainId: polygonAmoy.id, ... }),
  ],
  error: "PAYMENT-SIGNATURE header is required",
});

res.statusCode = 402;
res.setHeader("PAYMENT-REQUIRED", encodePaymentRequiredHeader(response));
res.setHeader("content-type", "application/json");
res.end(JSON.stringify(response));