Function DefaultApiFp

DefaultApi - functional programming interface

Export

  • DefaultApiFp(
        configuration?: Configuration,
    ): {
        getPaymentMethods(
            marketplaceId: string,
            paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetPaymentMethodsResponse>,
        >;
        initiatePayout(
            body: InitiatePayoutRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InitiatePayoutResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getPaymentMethods(
            marketplaceId: string,
            paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetPaymentMethodsResponse>,
        >;
        initiatePayout(
            body: InitiatePayoutRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InitiatePayoutResponse>,
        >;
    }

    • getPaymentMethods:function
      • getPaymentMethods(
            marketplaceId: string,
            paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetPaymentMethodsResponse>,
        >

      • Returns the list of payment methods for the seller, which can be filtered by method type. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

        Parameters

        • marketplaceId: string

          The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to Marketplace IDs.

        • OptionalpaymentMethodTypes: Set<GetPaymentMethodsPaymentMethodTypesEnum>

          A comma-separated list of the payment method types you want to include in the response.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetPaymentMethodsResponse>,
        >

        Throws

    • initiatePayout:function
      • initiatePayout(
            body: InitiatePayoutRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InitiatePayoutResponse>,
        >

      • Initiates an on-demand payout to the seller's default deposit method in Seller Central for the given marketplaceId and accountType, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

        Parameters

        • body: InitiatePayoutRequest

          The request body for the `initiatePayout` operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<InitiatePayoutResponse>,
        >

        Throws

Settings

Member Visibility