Neucron TypeScript SDK
Latest Neucron TypeScript SDK documentation for fintech wallet infrastructure.
@timechainlabs/neucron-ts-sdk is the TypeScript SDK for Neucron wallet infrastructure. It gives fintechs one typed client for authentication, wallets, assets, payments, invoices, payouts, business operations, app development, tokenization, and MCP-powered agent flows.
Current package
Package
@timechainlabs/neucron-ts-sdk
Current documented version
2.2.3
Runtime
Node.js >=20.19.0, modern browser, React Native-compatible ESM build
Main exports
NeucronSDK, service types, errors, schemas via /schemas
Install
npm install @timechainlabs/neucron-ts-sdk
Documentation sections
Identity & Access
sdk.auth, sdk.oauth, sdk.business, sdk.members, sdk.rbac, sdk.apps
Wallets & Assets
sdk.wallet, sdk.assets, sdk.paymail, sdk.assetSwap, sdk.utility
Payments & Operations
sdk.pay, sdk.customer, sdk.invoice, sdk.vendor, sdk.bill, sdk.payout, sdk.billing
Tokenization & Proofs
sdk.asset21, sdk.dataIntegrity, sdk.blob
Agent & MCP Flows
sdk.flows
Initialize
import NeucronSDK from '@timechainlabs/neucron-ts-sdk';
const sdk = new NeucronSDK({
authToken: process.env.NEUCRON_TOKEN,
sandbox: true,
timeoutMs: 30_000,
maxRetries: 2,
});SDK accessors
sdk.auth: Sign up, log in, store tokens, validate sessions, update profile data, and manage password flows.sdk.oauth: Build Sign in with Neucron using OAuth 2.0 authorization, token exchange, client metadata, and callback handling.sdk.business: Create, list, read, and update business profiles. Business IDs scope most commerce, team, app, and treasury operations.sdk.members: Invite team members and manage role assignments on a business.sdk.rbac: Read permissions and roles, create custom roles, update roles, and delete roles.sdk.apps: Create developer apps, fetch app secrets, update app metadata, and publish apps.sdk.wallet: Create wallets, addresses, sync assets, import assets, recover wallets, and read transactions/notifications.sdk.assets: Read asset metadata, balances, ledger entries, stats, owned asset details, events, and transfer assets.sdk.paymail: Create and manage human-readable payment aliases.sdk.assetSwap: List swappable assets, get rates, and execute asset swaps.sdk.utility: Create/update utility-token definitions and mint or redeem utility tokens.sdk.pay: Send assets by blockchain address, email, or Paymail.sdk.customer: Create and manage customers for invoices, collections, and AR workflows.sdk.invoice: Create invoices, payment collections, payment sessions, reminders, confirmations, revenue graphs, and collection status checks.sdk.vendor: Create/manage vendors, invitations, suspension, vendor ledger, expenses, and vendor payments.sdk.bill: Create, review, confirm, pay, and map vendor bills to payouts.sdk.payout: Create payout drafts/requests, update, confirm, trigger, list, and inspect payouts.sdk.billing: Manage Neucron platform billing, pricing plans, credits, invoices, payment methods, and billing analytics.sdk.asset21: Operate Asset21 regulated token workflows: configuration, customers, asset registration/deployment, requests, transfers, UTXO/output inspection, sync, and analytics.sdk.dataIntegrity: Upload files, text, or text arrays for proof-of-existence/data-integrity flows.sdk.blob: Upload documents and images for app, invoice, bill, or compliance workflows.sdk.flows: High-level flow orchestrators used by MCP tools and agentic finance workflows. These compose lower-level SDK modules into UI/task flows.
Latest additions to note
sdk.flowsexposes MCP/agent flow orchestrators for login, entity selection, wallet holdings, app publishing, AR collection, AP payouts, data integrity, and Asset21 workflows.@timechainlabs/neucron-ts-sdk/schemasexports validation schemas for advanced typed integrations.Business context must be passed per request on business-scoped methods.
GET requests can retry automatically; mutating requests are not auto-retried to avoid duplicate money movement.
Last updated