Interface PayoutsClient

Hierarchy

PayoutsClient

Index

Methods

Methods

approve

approve(merchantId: string, payoutId: string, postData: ApprovePayoutRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<PayoutResponse, ErrorResponse>>

Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout

Parameters
- merchantId: string
- payoutId: string
- postData: ApprovePayoutRequest
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<PayoutResponse, ErrorResponse>>

cancel

cancel(merchantId: string, payoutId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<void, ErrorResponse>>

Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout

Parameters
- merchantId: string
- payoutId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<void, ErrorResponse>>

cancelapproval

cancelapproval(merchantId: string, payoutId: string, paymentContext?: null | PaymentContext): Promise<SdkResponse<void, ErrorResponse>>

Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout

Parameters
- merchantId: string
- payoutId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<void, ErrorResponse>>

create

create(merchantId: string, postData: CreatePayoutRequest, paymentContext?: null | PaymentContext): Promise<SdkResponse<PayoutResponse, PayoutErrorResponse>>

Resource /{merchantId}/payouts - Create payout

Parameters
- merchantId: string
- postData: CreatePayoutRequest
- Optional paymentContext: null | PaymentContext
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?: null | PaymentContext): Promise<SdkResponse<PayoutResponse, ErrorResponse>>

Resource /{merchantId}/payouts/{payoutId} - Get payout

Parameters
- merchantId: string
- payoutId: string
- Optional paymentContext: null | PaymentContext
Returns Promise<SdkResponse<PayoutResponse, ErrorResponse>>