Skip to content

@klappay/types ​

TypeScript types and Zod schemas for the Klappay Core API — the request/response contracts for creating charges, managing webhooks, and everything else the API exposes. Published separately from the API implementation itself (which is closed-source), so integrators get accurate, versioned types without needing access to Klappay's own codebase.

bash
npm install @klappay/types zod

See Getting started for what's in this package and how to use it, or jump straight to a topic in the sidebar.

Topics ​

  • Getting started — install, what's in this package, typing vs. runtime validation
  • Charges — Charge, CreateChargeInput, AcceptedPayment, Capabilities, listing/pagination, TimelineEvent
  • Webhooks — every WebhookEventType, categories, Webhook, WebhookPayload, TypedWebhookPayload
  • Sandbox — SandboxTriggerInput, TriggerableChargeEvent
  • Distributions — PendingDistribution, PendingDistributionEvent, the 0xSplits keeper feed
  • Tokens & networks — Token, Network, and every chain/token constant
  • Errors & health — ErrorPayload, Health
  • Changelog — every published version of this package

Elsewhere ​

Public docs for @klappay/types, mirrored from this package's own docs/ folder.