Soledgic/Docs
Sign in

API Changelog

Track changes, additions, and deprecations across Soledgic API versions.

Version pinning: Include the Soledgic-Version header in your requests to pin your integration to a specific API version. If omitted, the current version is used.

0.5.2

CurrentMay 28, 2026

Trusted-publishing SDK release.

Security

  • Prepared the SDK public mirror for npm trusted publishing with GitHub Actions OIDC
  • Updated public SDK install snippets to point at @soledgic/sdk@0.5.2

0.5.1

DeprecatedMay 28, 2026

SDK package supply-chain metadata hardening.

Security

  • Removed the SDK install lifecycle script from the published package
  • Trimmed nonessential example URL strings from README and generated SDK docs
  • Added package audit guards for install scripts, stale postinstall artifacts, and bundled metadata URLs
  • Updated SDK publish guidance to prefer npm provenance from supported CI

0.5.0

DeprecatedMay 28, 2026

SDK validation and launch-readiness hardening.

Changed

  • Tightened SDK API key validation to require slk_test_... or slk_live_... keys
  • Updated public SDK install snippets to point at @soledgic/sdk@0.5.0
  • Kept package smoke tests aligned with the stricter local SDK contract

0.4.3

DeprecatedMay 26, 2026

SDK package metadata and install documentation alignment.

Fixed

  • Updated public SDK install snippets to point at @soledgic/sdk@0.4.3
  • Synchronized SDK lockfile metadata with the package version

0.4.1

DeprecatedMay 16, 2026

KYC and KYB intake helpers for review packets.

Added

  • Added SDK helpers for business KYB submission and status retrieval
  • Added SDK helpers for participant-scoped creator KYC submission and status retrieval
  • Added public API and OpenAPI coverage for business KYB and creator KYC endpoints

Changed

  • Aligned tax info request documentation around the public certify field

0.4.0

DeprecatedMay 13, 2026

Sandbox operations and webhook replay hardening.

Added

  • Added SDK helpers for webhook replay/retry delivery operations
  • Added sandbox cleanup previews and sandbox ledger runtime reset helpers
  • Added signed webhook test builders and sandbox webhook mode assertions for bridge smoke tests
  • Added dispute, chargeback, hold, and payout.executed webhook event types

Changed

  • Updated sandbox and webhook docs to include cleanup, replay, delivery filtering, and operational event coverage

0.3.3

DeprecatedMay 11, 2026

Sandbox, refund request, and receipt SDK alignment.

Added

  • Added public SDK helpers for sandbox checkout completion, sandbox webhook tests, and sandbox event listing
  • Added the buyer-facing refundRequests namespace for create, list, approve, reject, and cancel flows
  • Added Soledgic-owned receipt generation helpers for checkout and sale receipts

Changed

  • Updated SDK docs to clarify test-key sandbox behavior and package network access boundaries

0.3.2

DeprecatedMay 11, 2026

SDK install docs patch.

Fixed

  • Updated public SDK install snippets to point at @soledgic/sdk@0.3.2

0.3.1

DeprecatedMay 11, 2026

Webhook secret format and SDK docs refresh.

Changed

  • New Soledgic webhook endpoint secrets use the wh_sec_slk prefix
  • Updated SDK and webhook docs to treat webhook secrets as opaque values

Security

  • Expanded secret scanning and telemetry redaction to cover wh_sec_slk webhook secrets

0.3.0

DeprecatedMay 11, 2026

Public SDK release focused on wallet-first marketplace integration.

Changed

  • Updated public SDK positioning to wallet-first payment infrastructure for marketplaces, creator platforms, and closed-loop app economies
  • Added a concise SDK quickstart for user wallets, creator wallets, orders, and wallet activity
  • Focused the supported public SDK contract around users, creators, wallets, orders, purchases, payouts, refunds, holds, receipts, activity, and webhooks

Security

  • Added package audit checks for published SDK contents and secret/provider leakage
  • Verified published SDK contents are limited to README.md, dist/*, and package.json

2026-03-01

CurrentMarch 1, 2026

Initial stable release of the Soledgic API.

Added

  • Checkout sessions — create and manage payment links for creators
  • Payouts — automated and manual disbursements to creator bank accounts
  • Refunds — full and partial reversals with idempotency protection
  • Webhooks — real-time event delivery for payment lifecycle events
  • API key authentication with per-key rate limiting
  • Organization and creator management endpoints
  • Transaction history and reporting endpoints
  • Bank account tokenization and verification
  • Idempotency support on all write operations
  • OpenAPI 3.1 specification available at /openapi.yaml

Security

  • All endpoints require HTTPS
  • Rate limiting on all authenticated endpoints
  • IP-based blocking for abuse prevention
  • Request signing verification for webhook deliveries