Class PaymentTransferApi

PaymentTransferApi - object-oriented interface export PaymentTransferApi

Hierarchy (view full)

BaseAPI
- PaymentTransferApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiPaymentTransfersCancelPut getTransferDetails initiateTransfer listPaymentTransfers retryPayout

Constructors

constructor

new PaymentTransferApi(configuration?, basePath?, axios?): PaymentTransferApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PaymentTransferApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiPaymentTransfersCancelPut

apiPaymentTransfersCancelPut(paymentTransferReadDeets?, options?): Promise<AxiosResponse<PaymentTransfer, any>>
summary Cancel pending transfer
Parameters
- OptionalpaymentTransferReadDeets: PaymentTransferReadDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentTransfer, any>>
Throws
memberof PaymentTransferApi
- Defined in src/api/api.ts:25273

getTransferDetails

getTransferDetails(id, userId?, options?): Promise<AxiosResponse<PaymentTransfer, any>>
summary Retrieve a payment transfer by ID
Parameters
- id: string
  The id of the record you wish to retrieve
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentTransfer, any>>
Throws
memberof PaymentTransferApi
- Defined in src/api/api.ts:25286

initiateTransfer

initiateTransfer(paymentTransferCreateDeets?, options?): Promise<AxiosResponse<PaymentTransfer, any>>
summary Initiate balance withdrawal
Parameters
- OptionalpaymentTransferCreateDeets: PaymentTransferCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentTransfer, any>>
Throws
memberof PaymentTransferApi
- Defined in src/api/api.ts:25298

listPaymentTransfers

listPaymentTransfers(status?, direction?, limit?, page?, userId?, options?): Promise<AxiosResponse<PaymentTransferListResponse, any>>
summary Retrieve a list of payment transfers
Parameters
- Optionalstatus: string
- Optionaldirection: PaymentDirection
  push request smartContract paymentCycle transfer payout
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentTransferListResponse, any>>
Throws
memberof PaymentTransferApi
- Defined in src/api/api.ts:25314

retryPayout

retryPayout(id, paymentTransferRetryDeets?, options?): Promise<AxiosResponse<PaymentTransfer, any>>
summary Retry Failed Payout Transfers
Parameters
- id: string
- OptionalpaymentTransferRetryDeets: PaymentTransferRetryDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentTransfer, any>>
Throws
memberof PaymentTransferApi
- Defined in src/api/api.ts:25327