Interface PayoutsClient

interface PayoutsClient {
    approve(
        merchantId: string,
        payoutId: string,
        postData: ApprovePayoutRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<PayoutResponse, ErrorResponse>>;
    cancel(
        merchantId: string,
        payoutId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<void, ErrorResponse>>;
    cancelapproval(
        merchantId: string,
        payoutId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<void, ErrorResponse>>;
    create(
        merchantId: string,
        postData: CreatePayoutRequest,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<PayoutResponse, PayoutErrorResponse>>;
    find(
        merchantId: string,
        paymentContext: FindPayoutsParams,
    ): Promise<SdkResponse<FindPayoutsResponse, ErrorResponse>>;
    get(
        merchantId: string,
        payoutId: string,
        paymentContext?: PaymentContext | null,
    ): Promise<SdkResponse<PayoutResponse, ErrorResponse>>;
}

Index

Methods

approve cancel cancelapproval create find get

Methods

approve

approve(
    merchantId: string,
    payoutId: string,
    postData: ApprovePayoutRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<PayoutResponse, ErrorResponse>>
Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout
Parameters
- merchantId: string
- payoutId: string
- postData: ApprovePayoutRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<PayoutResponse, ErrorResponse>>

cancel

cancel(
    merchantId: string,
    payoutId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<void, ErrorResponse>>
Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout
Parameters
- merchantId: string
- payoutId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<void, ErrorResponse>>

cancelapproval

cancelapproval(
    merchantId: string,
    payoutId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<void, ErrorResponse>>
Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout
Parameters
- merchantId: string
- payoutId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<void, ErrorResponse>>

create

create(
    merchantId: string,
    postData: CreatePayoutRequest,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<PayoutResponse, PayoutErrorResponse>>
Resource /{merchantId}/payouts - Create payout
Parameters
- merchantId: string
- postData: CreatePayoutRequest
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<PayoutResponse, PayoutErrorResponse>>

find

find(
merchantId: string,
paymentContext: FindPayoutsParams,
): Promise<SdkResponse<FindPayoutsResponse, ErrorResponse>>
Resource /{merchantId}/payouts - Find payouts
Parameters
- merchantId: string
- paymentContext: FindPayoutsParams
Returns Promise<SdkResponse<FindPayoutsResponse, ErrorResponse>>

get

get(
    merchantId: string,
    payoutId: string,
    paymentContext?: PaymentContext | null,
): Promise<SdkResponse<PayoutResponse, ErrorResponse>>
Resource /{merchantId}/payouts/{payoutId} - Get payout
Parameters
- merchantId: string
- payoutId: string
- OptionalpaymentContext: PaymentContext | null
Returns Promise<SdkResponse<PayoutResponse, ErrorResponse>>