SystemEventsApi - axios parameter creator export

  • Parameters

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

    • apiEventAdminVerificationCodePost: ((body?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Sends a verification code notification with an email input.

        • (body?, options?): Promise<RequestArgs>
        • Parameters

          • Optionalbody: string

            The email to which the verification code will be sent.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiEventPayoutTransferInitiatedPost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Sends a payout transfer initiated notification with hardcoded values.

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiEventRecipientPaymentReceivedHasAccountPost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiEventRecipientPaymentReceivedNoAccountPost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiEventSenderPaymentFailurePost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Sends a payment failure notification with hardcoded values.

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiEventSenderPaymentSuccessPost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Sends a payment success notification with hardcoded values.

        • (options?): Promise<RequestArgs>
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>