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 marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to Marketplace IDs.

    • 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[]

      An optional query parameter that specifies the marketplaces from which to retrieve expected payouts. The marketplace ID is a globally unique identifier assigned to each Amazon marketplace. When provided, the response will only include expected payouts associated with the specified marketplaces. If omitted, expected payouts from all applicable marketplaces may be returned. To find the marketplace ID for your region, refer to Marketplace IDs.

    • OptionalaccountType: string

      An optional query parameter used to filter the response by a specific account type. When provided, only expected payouts associated with the specified account type will be returned.

    • 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>,
    >

    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

    • OptionalmarketplaceIds: string[]

      An optional query parameter that specifies the marketplaces from which to retrieve payouts. The marketplace ID is a globally unique identifier assigned to each Amazon marketplace. When provided, the response will only include payouts associated with the specified marketplaces. If omitted, payouts from all applicable marketplaces may be returned. To find the marketplace ID for your region, refer to Marketplace IDs.

    • OptionalcreatedAfter: string

      An optional query parameter to filter payouts created on or after this date-time. When provided, the response will only include payouts with a creation date on or after the specified date-time. The value must be formatted in ISO 8601 date-time format. If omitted, no start date filter is applied.

    • OptionalcreatedBefore: string

      An optional query parameter to filter payouts created before this date-time. When provided, the response will only include payouts with a creation date before the specified date-time (exclusive). The value must be formatted in ISO 8601 date-time format. If omitted, no end date filter is applied.

    • OptionalpayoutId: string

      An optional query parameter that specifies the payout to retrieve. When provided, the response will only include the payout matching the specified identifier.

    • OptionalaccountType: string

      An optional query parameter to filter payouts by a specific account type. When provided, only payouts associated with the specified account type will be returned.

    • 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<ListPayoutsResponse>,
    >

    Throws