SellerWallet V2024_03_01

class sp_api.api.SellerWalletV20240301(marketplace: ~sp_api.base.marketplaces.Marketplaces = Marketplaces.US, *, refresh_token=None, account='default', credentials=None, restricted_data_token=None, proxies=None, verify=True, timeout=None, version=None, credential_providers=None, auth_token_client_class=<class 'sp_api.auth.access_token_client.AccessTokenClient'>)

SellerWallet SP-API Client :link:

The Selling Partner API for Seller Wallet (Seller Wallet API) provides financial information that is relevant to a seller’s Seller Wallet account. You can obtain financial events, balances, and transfer schedules for Seller Wallet accounts. You can also schedule and initiate transactions.

list_accounts(self, **kwargs) → ApiResponse

Get Seller Wallet accounts for a seller.

Examples

literal blocks:

SellerWalletV20240301().list_accounts()

Parameters:: marketplaceId (key) – object | required A marketplace identifier. Specifies the marketplace for which items are returned.
Returns:: ApiResponse

get_account(self, accountId, **kwargs) → ApiResponse

Retrieve a Seller Wallet bank account by Amazon account identifier.

Examples

literal blocks:

SellerWalletV20240301().get_account("value")

Parameters:

accountId – object | required ID of the Amazon SW account
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

list_account_balances(self, accountId, **kwargs) → ApiResponse

Retrieve the balance in a given Seller Wallet bank account.

Examples

literal blocks:

SellerWalletV20240301().list_account_balances("value")

Parameters:

accountId – object | required ID of the Amazon SW account
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

list_account_transactions(self, **kwargs) → ApiResponse

Retrieve a list of transactions for a given Seller Wallet bank account.

Examples

literal blocks:

SellerWalletV20240301().list_account_transactions()

Parameters:

accountId (key) – object | required ID of the Amazon SW account
nextPageToken (key) – object | Pagination token to retrieve a specific page of results.
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

create_transaction(self, **kwargs) → ApiResponse

Create a transaction request from a Seller Wallet account to another customer-provided account.

Examples

literal blocks:

SellerWalletV20240301().create_transaction()

Parameters:

body – TransactionInitiationRequest | required Defines the actual payload of the request
destAccountDigitalSignature – object | required Digital signature for the destination bank account details. For more information, refer to [Third-Party Provider Signature Guidance](https://developer-docs.amazon.com/sp-api/docs/tpp-registration-signature-guidance).
amountDigitalSignature – object | required 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](https://developer-docs.amazon.com/sp-api/docs/tpp-registration-signature-guidance).
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

get_transaction(self, transactionId, **kwargs) → ApiResponse

Returns a transaction

Examples

literal blocks:

SellerWalletV20240301().get_transaction("value")

Parameters:

transactionId – object | required ID of the Amazon SW transaction
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

get_transfer_preview(self, **kwargs) → ApiResponse

Returns list of potential fees on a transaction based on the source and destination country currency code

Examples

literal blocks:

SellerWalletV20240301().get_transfer_preview()

Parameters:

sourceCountryCode (key) – object | required Represents 2 character country code of source transaction account in ISO 3166 standard format.
sourceCurrencyCode (key) – object | required Represents 3 letter currency code in ISO 4217 standard format of the source transaction country.
destinationCountryCode (key) – object | required Represents 2 character country code of destination transaction account in ISO 3166 standard format.
destinationCurrencyCode (key) – object | required Represents 3 letter currency code in ISO 4217 standard format of the destination transaction country.
baseAmount (key) – object | required Represents the base transaction amount without any markup fees, rates that will be used to get the transfer preview.
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

list_transfer_schedules(self, **kwargs) → ApiResponse

Retrieve transfer schedules of a Seller Wallet bank account.

Examples

literal blocks:

SellerWalletV20240301().list_transfer_schedules()

Parameters:

accountId (key) – object | required ID of the Amazon SW account
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
nextPageToken (key) – object | Pagination token to retrieve a specific page of results.

Returns:

ApiResponse

create_transfer_schedule(self, **kwargs) → ApiResponse

Create a transfer schedule request from a Seller Wallet account to another customer-provided account.

Examples

literal blocks:

SellerWalletV20240301().create_transfer_schedule()

Parameters:

body – TransferScheduleRequest | required Defines the actual payload of the request
destAccountDigitalSignature – object | required Digital signature for the destination bank account details.
amountDigitalSignature – object | required Digital signature for the source currency transaction amount.
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

update_transfer_schedule(self, **kwargs) → ApiResponse

Returns a transfer belonging to the updated scheduled transfer request

Examples

literal blocks:

SellerWalletV20240301().update_transfer_schedule()

Parameters:

body – TransferSchedule | required Defines the actual payload of the scheduled transfer request that is to be updated.
destAccountDigitalSignature – object | required Digital signature for the destination bank account details.
amountDigitalSignature – object | required Digital signature for the source currency transaction amount.
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

delete_schedule_transaction(self, transferScheduleId, **kwargs) → ApiResponse

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

Examples

literal blocks:

SellerWalletV20240301().delete_schedule_transaction("value")

Parameters:

transferScheduleId – object | required A unique reference ID for a scheduled transfer.
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

get_transfer_schedule(self, transferScheduleId, **kwargs) → ApiResponse

Find a particular Amazon Seller Wallet account transfer schedule.

Examples

literal blocks:

SellerWalletV20240301().get_transfer_schedule("value")

Parameters:

transferScheduleId – object | required The schedule ID of the Amazon Seller Wallet transfer.
marketplaceId (key) – object | required 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](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

Returns:

ApiResponse

PYTHON-AMAZON-SP-API

Navigation

Related Topics

Donate/support

SellerWallet V2024_03_01