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

            Defines the actual 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

            Defines the actual 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

            ID of the Amazon SW 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
        • Returns a transaction

          Parameters

          • transactionId: string

            ID of the Amazon SW 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
        • Returns list of potential fees on a transaction based on the source and destination country currency code

          Parameters

          • sourceCountryCode: string

            Represents 2 character country code of source transaction account in ISO 3166 standard format.

          • sourceCurrencyCode: string

            Represents 3 letter currency code in ISO 4217 standard format of the source transaction country.

          • destinationCountryCode: string

            Represents 2 character country code of destination transaction account in ISO 3166 standard format.

          • destinationCurrencyCode: string

            Represents 3 letter currency code in ISO 4217 standard format of the destination transaction country.

          • baseAmount: number

            Represents the base transaction amount without any markup fees, rates that will be used to get the transfer preview.

          • 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

            ID of the Amazon SW 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

            A marketplace identifier. Specifies the marketplace for which items are returned.

          • 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

            ID of the Amazon SW 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

            Pagination token to retrieve a specific page of results.

          • 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

            ID of the Amazon SW 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

            Pagination token to retrieve a specific page of results.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • updateTransferSchedule: function
        • 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

            Defines the actual 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>,
          >