btcpay-greenfield-node-client/dist/services/StorePaymentMethodsOnChainService.d.ts

## Installation

import type { OnChainPaymentMethodData } from '../models/OnChainPaymentMethodData';
import type { OnChainPaymentMethodPreviewResultData } from '../models/OnChainPaymentMethodPreviewResultData';
export declare class StorePaymentMethodsOnChainService {
    /**
     * Get store on-chain payment methods
     * View information about the stores' configured on-chain payment methods
     * @returns OnChainPaymentMethodDataList list of payment methods
     * @throws ApiError
     */
    /**
     * Get store on-chain payment method
     * View information about the specified payment method
     * @returns OnChainPaymentMethodData specified payment method
     * @throws ApiError
     */
    static storeOnChainPaymentMethodsGetOnChainPaymentMethod({ storeId, cryptoCode, }: {
        /** The store to fetch **/
        storeId: string;
        /** The crypto code of the payment method to fetch **/
        cryptoCode: string;
    }): Promise<OnChainPaymentMethodData>;
    /**
     * Update store on-chain payment method
     * Update the specified store's payment method
     * @returns OnChainPaymentMethodData updated specified payment method
     * @throws ApiError
     */
    static storeOnChainPaymentMethodsUpdateOnChainPaymentMethod({ storeId, cryptoCode, requestBody, }: {
        /** The store to fetch **/
        storeId: string;
        /** The crypto code of the payment method to update **/
        cryptoCode: string;
        requestBody: OnChainPaymentMethodData;
    }): Promise<OnChainPaymentMethodData>;
    /**
     * Remove store on-chain payment method
     * Removes the specified store payment method.
     * @returns any The payment method has been removed
     * @throws ApiError
     */
    static deleteStorePaymentMethodsOnChainService({ storeId, cryptoCode, }: {
        /** The store to fetch **/
        storeId: string;
        /** The crypto code of the payment method to update **/
        cryptoCode: string;
    }): Promise<any>;
    /**
     * Preview store on-chain payment method addresses
     * View addresses of the current payment method of the store
     * @returns OnChainPaymentMethodPreviewResultData specified payment method addresses
     * @throws ApiError
     */
    static storeOnChainPaymentMethodsGetOnChainPaymentMethodPreview({ storeId, cryptoCode, offset, amount, }: {
        /** The store to fetch **/
        storeId: string;
        /** The crypto code of the payment method to fetch **/
        cryptoCode: string;
        /** From which index to fetch the addresses **/
        offset?: number;
        /** Number of addresses to preview **/
        amount?: number;
    }): Promise<OnChainPaymentMethodPreviewResultData>;
    /**
     * Preview proposed store on-chain payment method addresses
     * View addresses of a proposed payment method of the store
     * @returns OnChainPaymentMethodPreviewResultData specified payment method addresses
     * @throws ApiError
     */
    static storeOnChainPaymentMethodsGetOnChainPaymentMethodPreview1({ storeId, cryptoCode, requestBody, offset, amount, }: {
        /** The store to fetch **/
        storeId: string;
        /** The crypto code of the payment method to fetch **/
        cryptoCode: string;
        requestBody: OnChainPaymentMethodData;
        /** From which index to fetch the addresses **/
        offset?: number;
        /** Number of addresses to preview **/
        amount?: number;
    }): Promise<OnChainPaymentMethodPreviewResultData>;
}