Share via

WalletItem Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Base class for all wallet items. All items that can be stored in the wallet are derived from this class.

Inheritance Hierarchy


Namespace:  Microsoft.Phone.Wallet
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)


Public MustInherit Class WalletItem
public abstract class WalletItem

The WalletItem type exposes the following members.


  Name Description
BarcodeImage Gets or sets an image that represents the barcode of the wallet item.
CustomerName Gets or sets the customer name of the wallet item.
CustomProperties Gets the collection of CustomWalletProperty objects associated with the wallet item.
DisplayName Gets or sets the name or title to be displayed to the user.
Id Gets the Id of the wallet item.
IsAcknowledged Gets or sets whether this item has been acknowledged by the app. Default value is false, meaning the item is new.
IssuerName Gets or sets the issuer name of the wallet item.
IssuerWebsite Gets or sets the full, http or https, URI for the issuer’s web site.
IsUserAttentionRequired Gets a value that indicates whether a user attention required notification is visible to the user.
LastUpdated Gets or sets the date and time the data for this item was last updated.
Logo159x159 Gets or sets the medium (159 x 159) logo of the wallet item.
Logo336x336 Gets or sets the large (336 x 336) logo of the wallet item.
Logo99x99 Gets or sets the small (99 x 99) logo of the wallet item.
Message Gets or sets the status message of the wallet item.
MessageNavigationUri Gets or sets Uri of the app to launch when the user taps the status message.
NavigationUri Gets or sets a relative URI to a page in the app.
Notes Gets or sets the notes for the wallet item
UserImage Gets or sets the user image of the wallet item.



  Name Description
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
SaveAsync Asynchronously saves changes to the wallet item. If this item is a Deal and the item is not in the Wallet, it will be added. If the item is a PaymentInstrument, WalletTransactionItem or an OnlinePaymentInstrument, you can only use this method to update the item if it already exists in the Wallet, otherwise an exception will be thrown. To add a new instance of PaymentInstrument or WalletTransactionItem, use the AddWalletItemTask. For more information, see How to use the add Wallet item task for Windows Phone 8.
SetUserAttentionRequiredNotification Sets or clears the notification for the wallet item.
ToString Returns a string that represents the current object. (Inherited from Object.)
Undo Undoes all changes to the wallet item since the last time SaveAsync was called.
UpdateId Updates the Id of the wallet item.




If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.


Windows Phone 8

For more info, see App capabilities and hardware requirements for Windows Phone 8.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also


Microsoft.Phone.Wallet Namespace