Class SystemEventsApi

SystemEventsApi - object-oriented interface export SystemEventsApi

Hierarchy (view full)

BaseAPI
- SystemEventsApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiEventAdminVerificationCodePost apiEventPayoutTransferInitiatedPost apiEventRecipientPaymentReceivedHasAccountPost apiEventRecipientPaymentReceivedNoAccountPost apiEventSenderPaymentFailurePost apiEventSenderPaymentSuccessPost

Constructors

constructor

new SystemEventsApi(configuration?, basePath?, axios?): SystemEventsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SystemEventsApi
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

apiEventAdminVerificationCodePost

apiEventAdminVerificationCodePost(body?, options?): Promise<AxiosResponse<void, any>>
summary Sends a verification code notification with an email input.
Parameters
- Optionalbody: string
  The email to which the verification code will be sent.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof SystemEventsApi
- Defined in src/api/api.ts:26339

apiEventPayoutTransferInitiatedPost

apiEventPayoutTransferInitiatedPost(options?): Promise<AxiosResponse<void, any>>
summary Sends a payout transfer initiated notification with hardcoded values.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof SystemEventsApi
- Defined in src/api/api.ts:26350

apiEventRecipientPaymentReceivedHasAccountPost

apiEventRecipientPaymentReceivedHasAccountPost(options?): Promise<AxiosResponse<void, any>>
summary Sends a payment received notification for a recipient with an account with hardcoded values.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof SystemEventsApi
- Defined in src/api/api.ts:26361

apiEventRecipientPaymentReceivedNoAccountPost

apiEventRecipientPaymentReceivedNoAccountPost(options?): Promise<AxiosResponse<void, any>>
summary Sends a payment received notification for a recipient without an account with hardcoded values.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof SystemEventsApi
- Defined in src/api/api.ts:26372

apiEventSenderPaymentFailurePost

apiEventSenderPaymentFailurePost(options?): Promise<AxiosResponse<void, any>>
summary Sends a payment failure notification with hardcoded values.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof SystemEventsApi
- Defined in src/api/api.ts:26383

apiEventSenderPaymentSuccessPost

apiEventSenderPaymentSuccessPost(options?): Promise<AxiosResponse<void, any>>
summary Sends a payment success notification with hardcoded values.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof SystemEventsApi
- Defined in src/api/api.ts:26394