Other Resources API Reference

This section provides a detailed reference for additional resource classes available in the Quicksilver SDK, complementing the primary QuicksilverClient API Reference.

---

Class: AdminResource

The AdminResource provides methods for administrative operations, typically requiring elevated privileges on the Quicksilver Engine.

Constructor

constructor(httpClient: HttpClient)

Initializes the AdminResource with an HTTP client instance.

• httpClient: HttpClient

Methods

getStats(): Promise<SystemStats>

Promise<SystemStats> // Get system statistics including account and transaction counts.

listAccounts(): Promise<Account[]>

Promise<Account[]> // List all accounts in the system. Requires admin privileges.

listTransactions(): Promise<Transaction[]>

Promise<Transaction[]> // List all transactions in the system. Requires admin privileges.

listActiveStreams(): Promise<StreamingTransaction[]>

Promise<StreamingTransaction[]> // List all active streaming transactions. Requires admin privileges.

---

Class: GatewaysResource

The GatewaysResource provides methods for interacting with payment gateways integrated into the Quicksilver Engine.

Constructor

constructor(httpClient: HttpClient)

Initializes the GatewaysResource with an HTTP client instance.

• httpClient: HttpClient

Methods

list(): Promise<GatewayInfo[]>

Promise<GatewayInfo[]> // List available payment gateways.

executeTransaction(transactionId: string): Promise<GatewayTransaction>

Promise<GatewayTransaction> // Execute a transaction through a payment gateway.

• transactionId: string - The ID of the transaction to execute.

---

Class: KycResource

The KycResource facilitates Know Your Customer (KYC) identity verification workflows. Note that KYC functionality is currently in development in the Engine.

Constructor

constructor(httpClient: HttpClient)

Initializes the KycResource with an HTTP client instance.

• httpClient: HttpClient

Methods

initiate(payload: KycInitiatePayload): Promise<KycInitiateResponse>

Promise<KycInitiateResponse> // Initiate KYC verification for an account.

• payload: KycInitiatePayload - The KYC initiation details.

getStatus(accountId: string): Promise<KycStatus>

Promise<KycStatus> // Get KYC status for an account.

• accountId: string - The ID of the account.

processWebhook(webhookData: any): Promise<{ success: boolean }>

Promise<{ success: boolean }> // Process KYC webhook (internal use, typically called by the KYC provider's webhook system).

• webhookData: any - The webhook payload from the KYC provider.