Package software.amazon.spapi.api.transfers.v2024_06_01

Class DefaultApi

  • public class DefaultApi
extends java.lang.Object

    • Field Detail

      • getPaymentMethodsBucket

        public final io.github.bucket4j.Bucket getPaymentMethodsBucket

      • initiatePayoutBucket

        public final io.github.bucket4j.Bucket initiatePayoutBucket

    • Constructor Detail

      • DefaultApi

        public DefaultApi​(ApiClient apiClient,
                  java.lang.Boolean disableRateLimiting)

    • Method Detail

      • getPaymentMethods

        public GetPaymentMethodsResponse getPaymentMethods​(java.lang.String marketplaceId,
                                                   java.util.List<java.lang.String> paymentMethodTypes)
                                            throws ApiException,
                                                   LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). (required)
        paymentMethodTypes - A comma-separated list of the payment method types you want to include in the response. (optional)
        Returns:
        GetPaymentMethodsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getPaymentMethodsWithHttpInfo

        public ApiResponse<GetPaymentMethodsResponse> getPaymentMethodsWithHttpInfo​(java.lang.String marketplaceId,
                                                                            java.util.List<java.lang.String> paymentMethodTypes)
                                                                     throws ApiException,
                                                                            LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). (required)
        paymentMethodTypes - A comma-separated list of the payment method types you want to include in the response. (optional)
        Returns:
        ApiResponse<GetPaymentMethodsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • getPaymentMethodsAsync

        public okhttp3.Call getPaymentMethodsAsync​(java.lang.String marketplaceId,
                                           java.util.List<java.lang.String> paymentMethodTypes,
                                           ApiCallback<GetPaymentMethodsResponse> callback)
                                    throws ApiException,
                                           LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        marketplaceId - The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). (required)
        paymentMethodTypes - A comma-separated list of the payment method types you want to include in the response. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails

      • initiatePayout

        public InitiatePayoutResponse initiatePayout​(InitiatePayoutRequest body)
                                      throws ApiException,
                                             LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `initiatePayout` operation. (required)
        Returns:
        InitiatePayoutResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • initiatePayoutWithHttpInfo

        public ApiResponse<InitiatePayoutResponse> initiatePayoutWithHttpInfo​(InitiatePayoutRequest body)
                                                               throws ApiException,
                                                                      LWAException
        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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `initiatePayout` operation. (required)
        Returns:
        ApiResponse<InitiatePayoutResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        LWAException - If calls to fetch LWA access token fails

      • initiatePayoutAsync

        public okhttp3.Call initiatePayoutAsync​(InitiatePayoutRequest body,
                                        ApiCallback<InitiatePayoutResponse> callback)
                                 throws ApiException,
                                        LWAException
        (asynchronously) 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
        Parameters:
        body - The request body for the `initiatePayout` operation. (required)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        LWAException - If calls to fetch LWA access token fails