Client

The main entry point of the SDK — a single, atomic client that exposes every resource through its own manager — an atomic, single-client design.

Constructor

Client

constructor(options: ClientOptions)

Parameters

• options: ClientOptions

Properties

version

Library version.

static readonly version = "2.3.2"

shared

Process-wide shared defaults maintained by Cosmos Pay (gateway URL, version, internal secrets). Mutate once at startup to change them for every client (e.g. self-hosting): Client.shared.baseURL = 'https://gateway.your-domain.com'.

static readonly shared: SharedConfig

shared

Resolved shared configuration for this client instance.

readonly shared: SharedConfig

webhookSecret

Default webhook signing secret for the webhook listener (if configured).

webhookSecret: string | undefined

rest

The underlying HTTP layer. Shared by every manager.

readonly rest: REST

Type REST

paymentIntents

Stellar payment intents — create/list/fetch/update/delete/validate.

readonly paymentIntents: PaymentIntentManager

Type PaymentIntentManager

webhooks

Webhook endpoints, delivery audit trail, and the event listener.

readonly webhooks: WebhookManager

Type WebhookManager

products

Products / prices.

readonly products: ProductManager

Type ProductManager

swaps

Same-chain swaps: the Stellar DEX, Jupiter on Solana, Kuru Flow on Monad.

readonly swaps: SwapManager

Type SwapManager

crossChainSwaps

Swaps between Stellar, Solana and Monad, settled by NEAR Intents.

readonly crossChainSwaps: CrossChainSwapManager

Type CrossChainSwapManager

usdt0

USDT0 from Stellar to EVM networks through LayerZero (mainnet only).

readonly usdt0: Usdt0Manager

Type Usdt0Manager

privatePayments

Private payments: amounts hidden on-chain (Stellar testnet only for now).

readonly privatePayments: PrivatePaymentManager

Type PrivatePaymentManager

liquidity

Liquidity pools: browse, positions, deposit / withdraw.

readonly liquidity: LiquidityManager

Type LiquidityManager

onramp

Fiat -> stablecoin: quotes, payins, trustlines, virtual accounts.

readonly onramp: OnrampManager

Type OnrampManager

offramp

Stablecoin -> fiat: quotes, authorize, payouts, compliance documents.

readonly offramp: OfframpManager

Type OfframpManager

activity

The client event stream: report events, read them back, summarize.

readonly activity: ActivityManager

Type ActivityManager

kyc

KYC / KYB: receivers, their wallets and their bank accounts.

readonly kyc: KycManager

Type KycManager

customers

Customers and their wallets.

readonly customers: CustomerManager

Type CustomerManager

analytics

Read-only analytics (summary, series, balances, logs).

readonly analytics: AnalyticsManager

Type AnalyticsManager

health

Service health probes (public).

readonly health: HealthManager

Type HealthManager

aliases

Payment handles: resolve, claim and manage @name aliases.

readonly aliases: AliasManager

Type AliasManager

assets

The asset registry: which (code, issuer) pairs exist per network, and who issues them.

readonly assets: AssetManager

Type AssetManager

plugins

Plugins this deployment serves: install, query, command.

readonly plugins: PluginManager

Type PluginManager

defindex

DeFindex vaults (when the deployment enables the native plugin).

readonly defindex: DefindexManager

Type DefindexManager

publicKey

The shared public API key an open-source wallet embeds.

readonly publicKey: PublicKeyManager

Type PublicKeyManager

Methods

setApiKey()

Update the API key used for subsequent requests.

setApiKey(apiKey: string): this

Parameters

• apiKey: string

Returns this

setWebhookSecret()

Set the default webhook signing secret for the webhook listener.

setWebhookSecret(secret: string): this

Parameters

• secret: string

Returns this

Related

• REST
• PaymentIntentManager
• WebhookManager
• ProductManager
• SwapManager
• CrossChainSwapManager
• Usdt0Manager
• PrivatePaymentManager
• LiquidityManager
• OnrampManager
• OfframpManager
• ActivityManager
• KycManager
• CustomerManager
• AnalyticsManager
• HealthManager
• AliasManager
• AssetManager
• PluginManager
• DefindexManager
• PublicKeyManager