Function FinancesTransfersApiFactory

Returns {
    getPaymentMethods(
        requestParameters: FinancesTransfersApiGetPaymentMethodsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPaymentMethodsResponse>;
    initiatePayout(
        requestParameters: FinancesTransfersApiInitiatePayoutRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InitiatePayoutResponse>;
    listExpectedPayouts(
        requestParameters?: FinancesTransfersApiListExpectedPayoutsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListExpectedPayoutsResponse>;
    listPayouts(
        requestParameters?: FinancesTransfersApiListPayoutsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPayoutsResponse>;
}

• getPaymentMethods: function

  • getPaymentMethods(
        requestParameters: FinancesTransfersApiGetPaymentMethodsRequest,
        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

    • requestParameters: FinancesTransfersApiGetPaymentMethodsRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetPaymentMethodsResponse>

    Throws

• initiatePayout: function

  • initiatePayout(
        requestParameters: FinancesTransfersApiInitiatePayoutRequest,
        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

    • requestParameters: FinancesTransfersApiInitiatePayoutRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<InitiatePayoutResponse>

    Throws

• listExpectedPayouts: function

  • listExpectedPayouts(
        requestParameters?: FinancesTransfersApiListExpectedPayoutsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListExpectedPayoutsResponse>

    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.

    Parameters

    • requestParameters: FinancesTransfersApiListExpectedPayoutsRequest = {}

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ListExpectedPayoutsResponse>

    Throws

• listPayouts: function

  • listPayouts(
        requestParameters?: FinancesTransfersApiListPayoutsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListPayoutsResponse>

    Returns a list of payouts for the selling partner's account. Results can be filtered by marketplaceIds, accountType, date range (createdAfter and createdBefore), or a specific payoutId. By default, the API returns payouts for all available marketplaces and account types. Results are sorted in descending order of their creation dates. 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.

    Parameters

    • requestParameters: FinancesTransfersApiListPayoutsRequest = {}

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ListPayoutsResponse>

    Throws