Class PayoutsApi

PayoutsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- PayoutsApi

Index

Constructors

Properties

axios basePath configuration

Methods

getPayout listPayouts

Constructors

constructor

new PayoutsApi(configuration?, basePath?, axios?): PayoutsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PayoutsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getPayout

getPayout(requestParameters, options?): Promise<AxiosResponse<Payout, any>>
Retrieves the details of an existing Payout.

Summary
Get a Payout

Throws

Memberof
PayoutsApi
Parameters
- requestParameters: PayoutsApiGetPayoutRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<Payout, any>>
- Defined in api/payouts-api.ts:397

listPayouts

listPayouts(requestParameters, options?): Promise<AxiosResponse<ListPayouts200Response, any>>
Returns a list of Payouts. The Payouts are sorted with the most recently created appearing first.

Summary
List all Payouts

Throws

Memberof
PayoutsApi
Parameters
- requestParameters: PayoutsApiListPayoutsRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ListPayouts200Response, any>>
- Defined in api/payouts-api.ts:409

Generated using TypeDoc