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

## Installation

import type { CreatePayoutRequest } from '../models/CreatePayoutRequest';
import type { PayoutData } from '../models/PayoutData';
import type { PayoutDataList } from '../models/PayoutDataList';
import type { PullPaymentData } from '../models/PullPaymentData';
export declare class PullPaymentsPublicService {
    /**
     * Get Pull Payment
     * Get a pull payment
     * @returns PullPaymentData Information about the pull payment
     * @throws ApiError
     */
    static pullPaymentsGetPullPayment({ pullPaymentId, }: {
        /** The ID of the pull payment **/
        pullPaymentId: string;
    }): Promise<PullPaymentData>;
    /**
     * Get Payouts
     * Get payouts
     * @returns PayoutDataList The payouts of the pull payment
     * @throws ApiError
     */
    static pullPaymentsGetPayouts({ pullPaymentId, includeCancelled, }: {
        /** The ID of the pull payment **/
        pullPaymentId: string;
        /** Whether this should list cancelled payouts **/
        includeCancelled?: boolean;
    }): Promise<PayoutDataList>;
    /**
     * Create Payout
     * Create a new payout
     * @returns PayoutData A new payout has been created
     * @throws ApiError
     */
    static pullPaymentsCreatePayout({ pullPaymentId, requestBody, }: {
        /** The ID of the pull payment **/
        pullPaymentId: string;
        requestBody: CreatePayoutRequest;
    }): Promise<PayoutData>;
}