The `QuicksilverClient` is the primary entry point for interacting with the Quicksilver Engine API. It provides access to various resources and fluent builders for constructing complex financial logic
The QuicksilverClient is the primary entry point for interacting with the Quicksilver Engine API. It provides access to various resources and fluent builders for constructing complex financial logic.
QuicksilverClientconstructor(apiKey: string, options?: ClientOptions)Initializes the QuicksilverClient.
apiKey: string - Your API key for authentication with the Quicksilver Engine.options: ClientOptions - Optional configuration for the client, such as environment, base URL, and timeout.accounts: AccountsResourceAccountsResource // Provides methods for managing accounts, including creation, retrieval, listing, updating, and deletion.
transactions: TransactionsResourceTransactionsResource // Provides methods for managing transactions, including creation, retrieval, listing, updating, and deletion.
streams: StreamsResourceStreamsResource // Provides methods for managing streaming payments, including retrieval, listing, control (pause, resume, stop), and real-time event subscriptions.
admin: AdminResourceAdminResource // Provides methods for administrative operations, typically requiring elevated privileges (e.g., system statistics, listing all accounts).
gateways: GatewaysResourceGatewaysResource // Provides methods for interacting with payment gateways, such as listing available gateways and executing transactions through them.
kyc: KycResourceKycResource // Provides methods for Know Your Customer (KYC) identity verification workflows.
condition(): ConditionBuilderConditionBuilder // Creates a new ConditionBuilder instance, which is the entry point for fluently defining conditional logic for transactions.
product(id: string): ProductBuilderProductBuilder // Creates a new ProductBuilder instance, used to fluently define programmable products and services with pricing, guarantees, and workflows.
id: string - A unique identifier for the product.createAccount(data: AccountData): AccountAccount // Creates an Account active model object from raw account data, allowing for fluent interactions.
data: AccountData - The raw data conforming to the Account interface.createTransaction(data: TransactionData): TransactionTransaction // Creates a Transaction active model object from raw transaction data, allowing for fluent interactions.
data: TransactionData - The raw data conforming to the Transaction interface.findTransactions(query: (t: TransactionQuery) => TransactionQuery): Promise<any[]>Promise<any[]> // (Illustrative) A fluent query builder for finding transactions.
query: (t: TransactionQuery) => TransactionQuery - A callback function to build the transaction query.getApiKey(): stringstring // Returns the client's API key, masked for security.
getBaseURL(): stringstring // Returns the base URL currently being used for API requests.
ping(): Promise<{ pong: boolean; timestamp: string }>Promise<{ pong: boolean; timestamp: string }> // Tests the API connection by sending a ping request.
health(): Promise<{ status: string; version: string; timestamp: string }>Promise<{ status: string; version: string; timestamp: string }> // Retrieves the API's health status, including version and timestamp.
getOpenApiSpec(): Promise<any>Promise<any> // Retrieves the OpenAPI (Swagger) specification for the API.