Function FinancesTransfersApiFp

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>,
    >;
    listExpectedPayouts(
        marketplaceIds?: string[],
        accountType?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListExpectedPayoutsResponse>,
    >;
    listPayouts(
        marketplaceIds?: string[],
        createdAfter?: string,
        createdBefore?: string,
        payoutId?: string,
        accountType?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPayoutsResponse>,
    >;
}

• 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 Amazon store from which you want to retrieve payment methods. For the list of store identifiers, refer to Store Identifiers.

    • 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

• listExpectedPayouts: function

  • listExpectedPayouts(
        marketplaceIds?: string[],
        accountType?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • OptionalmarketplaceIds: string[]

      The Amazon stores from which to retrieve payouts. The Amazon store ID is a globally unique identifier assigned to each Amazon store. If omitted, the response includes payouts from all applicable stores. To find the Amazon store ID for your region, refer to Store Identifiers.

    • OptionalaccountType: string

      The response only includes the accounts of the specified account type.

    • OptionalnextToken: string

      The response includes `nextToken` when the number of results exceeds the specified page size. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• listPayouts: function

  • listPayouts(
        marketplaceIds?: string[],
        createdAfter?: string,
        createdBefore?: string,
        payoutId?: string,
        accountType?: string,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListPayoutsResponse>,
    >

    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.

    Parameters

    • OptionalmarketplaceIds: string[]

      The Amazon stores from which to retrieve payouts. The Amazon store ID is a globally unique identifier assigned to each Amazon store. If omitted, the response includes payouts from all applicable stores. To find the Amazon store ID for your region, refer to Store Identifiers.

    • OptionalcreatedAfter: string

      The response only includes payouts created on or after this date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no start date filter is applied.

    • OptionalcreatedBefore: string

      The response only includes payouts created before this date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no end date filter is applied.

    • OptionalpayoutId: string

      The response only includes the payout matching the specified identifier.

    • OptionalaccountType: string

      The response only includes payouts associated with the specified account type.

    • OptionalnextToken: string

      The response includes `nextToken` when the number of results exceeds the page size. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws