Create deposits

The main entrypoints most integrators start with.

• offramp()

  Create, confirm, and delegate a deposit in one call.

• createOfframp()

  Build a reusable SDK instance for long-lived clients and bots.

Operate deposits

Inspect lifecycle state, close deposits, and manage private OTC links.

• deposits()

  List a wallet's deposits and remaining inventory.

• close()

  Close a deposit manually by deposit ID.

• enableOtc() / disableOtc()

  Restrict or reopen a deposit for a single taker wallet.

• getOtcLink()

  Build the taker-facing URL without creating a transaction.

Types and constants

Use the generated types to validate inputs and wire your own UI.

• OfframpParams

  Amount, platform, currency, identifier, attribution, and OTC options.

• OfframpResult

  Deposit ID, transaction hash, resumed state, and OTC link.

• PLATFORMS / CURRENCIES

  Canonical payment rails and supported fiat currency metadata.

• OFFRAMP_ERROR_CODES

  Error categories for user cancellations, validation failures, and chain issues.

Telemetry and wiring

Optional helpers for attribution and internal instrumentation.

• createTelemetryContext()

  Create a shared telemetry emitter for multi-step integrations.

• emitEvent()

  Send one-off telemetry events with the SDK's attribution shape.

• sanitizeAttributionId()

  Normalize integrator, referral, and idempotency values before sending them.