Skip to main content
Pvium ships three official SDKs from the pvium/sdks monorepo. Each SDK provides methods for payouts, invites, OAuth, and webhook verification. Shared test fixtures check that the SDKs produce matching payout hashes, signatures, and Merkle proofs.

Initialize

Create and finalize a payout

The examples below create a payout, sign its details with your organization’s signing key, and return a link you can open to fund it.

Language notes

  • TypeScript — written in TypeScript with full type definitions; the primary SDK and the one this documentation’s examples default to.
  • Python — the PyPI package is pvium, the import is pvium_sdk. Use AsyncPviumSdk to call SDK methods with await in asynchronous Python code.
  • Go — access services through the SDK struct (sdk.Payouts, sdk.Invites, sdk.OAuth, sdk.Endpoints) and every call takes a context.Context.
Payouts with more than 200 payees should be created as Scheduled rather than Instant — use createFinalized to create and finalize them in one call.

What every SDK covers

  • Payouts — create, list, and get payouts; manage payments and identity-based recipients; finalize with your signer and get funding links; authorize delegated signing keys.
  • Invites — payout invites and organization open invites, including the cryptographic invite proofs.
  • OAuth — token exchange and refresh for acting on a user’s granted scopes.
  • Webhook helpers — verify webhook deliveries before trusting them.
  • Signing utilities — private-key signers plus lower-level hashing helpers for custom signer setups.

Where to start

Send your first payout

Create and sign a payout, fund it from your wallet, and check its status.

Authentication

API keys, OAuth tokens, and signer keys.