API overview

Use the Pvium API and Node SDK to create payouts, resolve recipients from identities, finalize payouts with your organization’s signature, and track and reconcile everything from your backend. To send and track a payout from your backend:

Create a payout with payments, or with recipients identified by handle, email, wallet, or social account.
Finalize it with your organization’s signer — this locks recipients, amounts, and schedule cryptographically.
Fund it through the generated funding link, from whatever wallet your treasury controls.
Track it through webhooks and payout records.

Creating and finalizing never move money. Funding is a separate, wallet-gated step — see Security for why.

Environments

Pvium separates production and sandbox environments. Accounts, organizations, API keys, and payouts do not carry across environments.

Environment	API base URL	Dashboard	Use for
Production	`https://api.pvium.com/v1`	pvium.com	Live payouts on mainnet rails
Sandbox	`https://api-sandbox.pvium.com/v1`	sandbox.pvium.com	Integration testing on test rails such as `base-testnet`

Set environment when initializing the SDK to choose the API endpoint for your requests:

import { PviumSdk } from '@pvium/sdk';

const pvium = PviumSdk.init({
  environment: 'sandbox', // or 'production'
  apiKey: process.env.PVIUM_API_KEY,
  clientId: process.env.PVIUM_CLIENT_ID,
});

from pvium_sdk import PviumSdk, PviumSdkConfig

pvium = PviumSdk.init(
    PviumSdkConfig(
        environment="sandbox",  # or "production"
        apiKey="your_api_key",
        clientId="your_client_id",
    )
)

package main

import (
	"os"

	pvium "github.com/pvium/sdks/go-sdk"
)

func main() {
	sdk := pvium.Init(pvium.Config{
		Environment: pvium.EnvironmentSandbox, // or EnvironmentProduction
		APIKey:      os.Getenv("PVIUM_API_KEY"),
		ClientID:    os.Getenv("PVIUM_CLIENT_ID"),
	})
	_ = sdk
}

Funding links generated in an environment resolve to that environment’s dashboard host, so a sandbox payout is always funded through the sandbox checkout.

Build against sandbox first. Sandbox payouts settle on test rails, so you can exercise the full create → finalize → fund → track loop without real funds.

Rails and currencies

Chain	Rail	Environment
`base`	Base	Production
`bsc`	BNB Smart Chain	Production
`base-testnet`	Base Sepolia	Sandbox

Currency	Description
`USDC`	USD Coin
`USDT`	Tether USD

payoutCurrency is optional. If you leave it unset, the payout uses the chain’s default currency. You can also set a specific token per payment instead of a payout-wide currency.

Organizations

Every API integration acts as an organization — the workspace your payouts, records, and payees live in. (Organizations are called client apps in some older API paths.) You create one from the dashboard with Create Organization: give it a name, link it to your business profile, and optionally add a description, website, and logo. Each organization gets:

A client ID that identifies it in API calls and OAuth flows
Its own API keys, scoped to that organization
Its own webhook configuration and signing secret
Its own payouts, records, tax forms, and connected payees

Create separate organizations for separate payout programs — for example, one for contractor payroll and one for creator rewards — so their keys, records, and payees stay isolated.

Organizations concept

Learn which data and credentials belong to an organization and how to link it to a business profile.

Next steps

Send your first payout

Create, finalize, and fund a payout with the Node SDK.

Authentication

API keys, OAuth access tokens, and signer keys.

Create a payout

Payout types, chains, currencies, payments, and recipients.

Finalize a payout

Sign a payout and generate its funding link.

Get started

Payout automation

Concepts

Environments

Rails and currencies

Organizations

Organizations concept

Next steps

Send your first payout

Authentication

Create a payout

Finalize a payout

​Environments

​Rails and currencies

​Organizations

Organizations concept

​Next steps

Send your first payout

Authentication

Create a payout

Finalize a payout

Environments

Rails and currencies

Organizations

Next steps