Selling Partner API SDK for JavaScript
    Preparing search index...
    • SellerWalletApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          createTransaction(
              destAccountDigitalSignature: string,
              amountDigitalSignature: string,
              marketplaceId: string,
              body: TransactionInitiationRequest,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<CreateTransactionResponse>,
          >;
          createTransferSchedule(
              destAccountDigitalSignature: string,
              amountDigitalSignature: string,
              marketplaceId: string,
              body: TransferScheduleRequest,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<TransferSchedule>,
          >;
          deleteScheduleTransaction(
              transferScheduleId: string,
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<DeleteTransferSchedule>,
          >;
          getAccount(
              accountId: string,
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<BankAccount>,
          >;
          getTransaction(
              transactionId: string,
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Transaction>,
          >;
          getTransferPreview(
              sourceCountryCode: string,
              sourceCurrencyCode: string,
              destinationCountryCode: string,
              destinationCurrencyCode: string,
              baseAmount: number,
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<TransferRatePreview>,
          >;
          getTransferSchedule(
              transferScheduleId: string,
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<TransferSchedule>,
          >;
          listAccountBalances(
              accountId: string,
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BalanceListing>,
          >;
          listAccounts(
              marketplaceId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BankAccountListing>,
          >;
          listAccountTransactions(
              accountId: string,
              marketplaceId: string,
              nextPageToken?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<TransactionListing>,
          >;
          listTransferSchedules(
              accountId: string,
              marketplaceId: string,
              nextPageToken?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<TransferScheduleListing>,
          >;
          updateTransferSchedule(
              destAccountDigitalSignature: string,
              amountDigitalSignature: string,
              marketplaceId: string,
              body: TransferSchedule,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<TransferSchedule>,
          >;
      }

      • createTransaction: function
        • Create a transaction request from a Seller Wallet account to another customer-provided account.

          Parameters

          • destAccountDigitalSignature: string

            Digital signature for the destination bank account details. For more information, refer to Third-Party Provider Signature Guidance.

          • amountDigitalSignature: string

            Digital signature for the source currency transaction amount. Sign in the order of the request definitions. You can omit empty or optional fields. For more information, refer to Third-Party Provider Signature Guidance.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • body: TransactionInitiationRequest

            The payload of the request

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • createTransferSchedule: function
        • Create a transfer schedule request from a Seller Wallet account to another customer-provided account.

          Parameters

          • destAccountDigitalSignature: string

            Digital signature for the destination bank account details.

          • amountDigitalSignature: string

            Digital signature for the source currency transaction amount.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • body: TransferScheduleRequest

            The payload of the request.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • deleteScheduleTransaction: function
        • Delete a transaction request that is scheduled from Amazon Seller Wallet account to another customer-provided account.

          Parameters

          • transferScheduleId: string

            A unique reference ID for a scheduled transfer.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • getAccount: function
        • Retrieve a Seller Wallet bank account by Amazon account identifier.

          Parameters

          • accountId: string

            The ID of the Amazon Seller Wallet account.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • getTransaction: function
        • Find a transaction by the Amazon transaction identifier.

          Parameters

          • transactionId: string

            The ID of the Amazon Seller Wallet transaction.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • getTransferPreview: function
        • Retrieve a list of potential fees on a transaction.

          Parameters

          • sourceCountryCode: string

            Country code of the source transaction account in ISO 3166 format.

          • sourceCurrencyCode: string

            Currency code of the source transaction country in ISO 4217 format.

          • destinationCountryCode: string

            Country code of the destination transaction account in ISO 3166 format.

          • destinationCurrencyCode: string

            Currency code of the destination transaction country in ISO 4217 format.

          • baseAmount: number

            The base transaction amount without any markup fees.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • getTransferSchedule: function
        • Find a particular Amazon Seller Wallet account transfer schedule.

          Parameters

          • transferScheduleId: string

            The schedule ID of the Amazon Seller Wallet transfer.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • listAccountBalances: function
        • Retrieve the balance in a given Seller Wallet bank account.

          Parameters

          • accountId: string

            The ID of the Amazon Seller Wallet account.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • listAccounts: function
        • Get Seller Wallet accounts for a seller.

          Parameters

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • listAccountTransactions: function
        • Retrieve a list of transactions for a given Seller Wallet bank account.

          Parameters

          • accountId: string

            The ID of the Amazon Seller Wallet account.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • OptionalnextPageToken: string

            A token that you use to retrieve the next page of results. The response includes `nextPageToken` when the number of results exceeds 100. 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 `nextPageToken` is null. Note that this operation can return empty pages.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • listTransferSchedules: function
        • Retrieve transfer schedules of a Seller Wallet bank account.

          Parameters

          • accountId: string

            The ID of the Amazon Seller Wallet account.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • OptionalnextPageToken: string

            A token that you use to retrieve the next page of results. The response includes `nextPageToken` when the number of results exceeds the specified `pageSize` value. 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 `nextPageToken` is null. Note that this operation can return empty pages.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • updateTransferSchedule: function
        • Update transfer schedule information. Returns a transfer belonging to the updated scheduled transfer request.

          Parameters

          • destAccountDigitalSignature: string

            Digital signature for the destination bank account details.

          • amountDigitalSignature: string

            Digital signature for the source currency transaction amount.

          • marketplaceId: string

            The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.

          • body: TransferSchedule

            The payload of the scheduled transfer request that is to be updated.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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