Function SystemEventsApiFactory

SystemEventsApi - factory interface export

  • SystemEventsApiFactory(configuration?, basePath?, axios?): {
        apiEventAdminVerificationCodePost(body?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventPayoutTransferInitiatedPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventRecipientPaymentReceivedHasAccountPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventRecipientPaymentReceivedNoAccountPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventSenderPaymentFailurePost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventSenderPaymentSuccessPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiEventAdminVerificationCodePost(body?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventPayoutTransferInitiatedPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventRecipientPaymentReceivedHasAccountPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventRecipientPaymentReceivedNoAccountPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventSenderPaymentFailurePost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiEventSenderPaymentSuccessPost(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

    • apiEventAdminVerificationCodePost:function
      • apiEventAdminVerificationCodePost(body?, options?): AxiosPromise<void>

      • 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 AxiosPromise<void>

        Throws

    • apiEventPayoutTransferInitiatedPost:function
      • apiEventPayoutTransferInitiatedPost(options?): AxiosPromise<void>

      • summary Sends a payout transfer initiated notification with hardcoded values.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiEventRecipientPaymentReceivedHasAccountPost:function
      • apiEventRecipientPaymentReceivedHasAccountPost(options?): AxiosPromise<void>

      • summary Sends a payment received notification for a recipient with an account with hardcoded values.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiEventRecipientPaymentReceivedNoAccountPost:function
      • apiEventRecipientPaymentReceivedNoAccountPost(options?): AxiosPromise<void>

      • summary Sends a payment received notification for a recipient without an account with hardcoded values.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiEventSenderPaymentFailurePost:function
      • apiEventSenderPaymentFailurePost(options?): AxiosPromise<void>

      • summary Sends a payment failure notification with hardcoded values.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiEventSenderPaymentSuccessPost:function
      • apiEventSenderPaymentSuccessPost(options?): AxiosPromise<void>

      • summary Sends a payment success notification with hardcoded values.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

Settings

Member Visibility