Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...
    • FinancesTransfersApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          getPaymentMethods: (
              marketplaceId: string,
              paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          initiatePayout: (
              body: InitiatePayoutRequest,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          listExpectedPayouts: (
              marketplaceIds?: string[],
              accountType?: string,
              nextToken?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          listPayouts: (
              marketplaceIds?: string[],
              createdAfter?: string,
              createdBefore?: string,
              payoutId?: string,
              accountType?: string,
              nextToken?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • getPaymentMethods: (
            marketplaceId: string,
            paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • initiatePayout: (
            body: InitiatePayoutRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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.

      • listExpectedPayouts: (
            marketplaceIds?: string[],
            accountType?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Returns the upcoming expected payouts from Amazon associated with a partner's account for the specified parameters. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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.

      • listPayouts: (
            marketplaceIds?: string[],
            createdAfter?: string,
            createdBefore?: string,
            payoutId?: string,
            accountType?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieve a list of payouts for the selling partner's account. You can filter results by marketplaceIds, accountType, date range (createdAfter and createdBefore), or a specific payoutId. By default, the response includes payouts for all available marketplaces and account types. Results are grouped by the seller's account groups. Within each account group results are sorted by their creation date, with the most recent appearing first. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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.