Interface PayoutsClient

Hierarchy

PayoutsClient

Index

Methods

Methods

approve

approve(merchantId: string, payoutId: string, postData: ApprovePayoutRequest, paymentContext: null | PaymentContext, cb: SdkCallback): void

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

Parameters
- merchantId: string
- payoutId: string
- postData: ApprovePayoutRequest
- paymentContext: null | PaymentContext
- cb: SdkCallback
  
  The callback for the response. If the call was successfull, the response body type will be PayoutResponse. If the call was not successful, the response body type will be ErrorResponse.
Returns void

cancel

cancel(merchantId: string, payoutId: string, paymentContext: null | PaymentContext, cb: SdkCallback): void

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

Parameters
- merchantId: string
- payoutId: string
- paymentContext: null | PaymentContext
- cb: SdkCallback
  
  The callback for the response. If the call was successfull, the response body type will be null. If the call was not successful, the response body type will be ErrorResponse.
Returns void

cancelapproval

cancelapproval(merchantId: string, payoutId: string, paymentContext: null | PaymentContext, cb: SdkCallback): void

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

Parameters
- merchantId: string
- payoutId: string
- paymentContext: null | PaymentContext
- cb: SdkCallback
  
  The callback for the response. If the call was successfull, the response body type will be null. If the call was not successful, the response body type will be ErrorResponse.
Returns void

create

create(merchantId: string, postData: CreatePayoutRequest, paymentContext: null | PaymentContext, cb: SdkCallback): void

Resource /{merchantId}/payouts - Create payout

Parameters
- merchantId: string
- postData: CreatePayoutRequest
- paymentContext: null | PaymentContext
- cb: SdkCallback
  
  The callback for the response. If the call was successfull, the response body type will be PayoutResponse. If the call was not successful, the response body type will be one of PayoutErrorResponse or ErrorResponse.
Returns void

find

find(merchantId: string, paymentContext: FindPayoutsParams, cb: SdkCallback): void

Resource /{merchantId}/payouts - Find payouts

Parameters
- merchantId: string
- paymentContext: FindPayoutsParams
- cb: SdkCallback
  
  The callback for the response. If the call was successfull, the response body type will be FindPayoutsResponse. If the call was not successful, the response body type will be ErrorResponse.
Returns void

get

get(merchantId: string, payoutId: string, paymentContext: null | PaymentContext, cb: SdkCallback): void

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

Parameters
- merchantId: string
- payoutId: string
- paymentContext: null | PaymentContext
- cb: SdkCallback
  
  The callback for the response. If the call was successfull, the response body type will be PayoutResponse. If the call was not successful, the response body type will be ErrorResponse.
Returns void