@vonpay/checkout-node

Node.js / TypeScript SDK for the Von Payments Checkout API. Create hosted checkout sessions, verify webhook signatures, and validate signed return redirects.

Install

npm install @vonpay/checkout-node

Requires: Node 20+. ESM only. Zero runtime dependencies.

Quick start

import { VonPayCheckout, VonPayError } from "@vonpay/checkout-node";

const vonpay = new VonPayCheckout("vp_sk_test_...");

const session = await vonpay.sessions.create({
  amount: 1499,
  currency: "USD",
  country: "US",
  successUrl: "https://example.com/order/123/confirm",
});

console.log(session.checkoutUrl);
// https://checkout.vonpay.com/checkout?session=vp_cs_test_...

Features

Typed session / webhook / error objects — full CheckoutSession, SessionStatus, WebhookEvent, VonPayError, discriminated-union ErrorCode.
Webhook verification — HMAC-SHA256 with ±5 minute timestamp replay protection via webhooks.constructEvent().
Signed return URL verification (v1 + v2) — VonPayCheckout.verifyReturnSignature() supports both legacy v1 signatures and v2 signatures that bind successUrl, keyMode, and iat freshness.
Auto-retry — exponential backoff on 429 / 5xx with Retry-After header support.
Request ID tracing — every response includes X-Request-Id for support tickets.
Rate-limit info — parsed from response headers into VonPayError.rateLimit.

Documentation

License

MIT