Function DefaultApiFactory

DefaultApi - factory interface

Export

  • DefaultApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        getPaymentMethods(
            requestParameters: DefaultApiGetPaymentMethodsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetPaymentMethodsResponse>;
        initiatePayout(
            requestParameters: DefaultApiInitiatePayoutRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InitiatePayoutResponse>;
    }

  • Parameters

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

    Returns {
        getPaymentMethods(
            requestParameters: DefaultApiGetPaymentMethodsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetPaymentMethodsResponse>;
        initiatePayout(
            requestParameters: DefaultApiInitiatePayoutRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InitiatePayoutResponse>;
    }

    • getPaymentMethods:function
      • getPaymentMethods(
            requestParameters: DefaultApiGetPaymentMethodsRequest,
            options?: RawAxiosRequestConfig,
        ): 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

        Returns AxiosPromise<GetPaymentMethodsResponse>

        Throws

    • initiatePayout:function
      • initiatePayout(
            requestParameters: DefaultApiInitiatePayoutRequest,
            options?: RawAxiosRequestConfig,
        ): 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

        Returns AxiosPromise<InitiatePayoutResponse>

        Throws

Settings

Member Visibility