PaymentInstrument Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
A wallet item that represents a payment instrument.
Inheritance Hierarchy
System..::.Object
Microsoft.Phone.Wallet..::.WalletItem
Microsoft.Phone.Wallet..::.WalletTransactionItemBase
Microsoft.Phone.Wallet..::.PaymentInstrument
Namespace: Microsoft.Phone.Wallet
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.
Syntax
Public NotInheritable Class PaymentInstrument _
Inherits WalletTransactionItemBase
public sealed class PaymentInstrument : WalletTransactionItemBase
<PaymentInstrument .../>
The PaymentInstrument type exposes the following members.
Constructors
Name | Description | |
---|---|---|
PaymentInstrument()()() | Initializes a new instance of the PaymentInstrument class. | |
PaymentInstrument(String) | Initializes a new instance of the PaymentInstrument class. |
Top
Properties
Name | Description | |
---|---|---|
AccountNumber | Gets or sets the account number of the card. | |
BackgroundColor | Gets or sets the background color for the front of the card view. (Inherited from WalletTransactionItemBase.) | |
BarcodeImage | Gets or sets an image that represents the barcode of the wallet item. (Inherited from WalletItem.) | |
BillingAddress | Gets or sets the user’s billing address. (Inherited from WalletTransactionItemBase.) | |
BillingPhone | Gets or sets the user’s phone number. (Inherited from WalletTransactionItemBase.) | |
CustomerName | Gets or sets the customer name of the wallet item. (Inherited from WalletItem.) | |
CustomProperties | Gets the collection of CustomWalletProperty objects associated with the wallet item. (Inherited from WalletItem.) | |
DisplayAvailableBalance | Gets or sets the card’s available balance. (Inherited from WalletTransactionItemBase.) | |
DisplayAvailableCredit | Gets or sets the available credit on this card. (Inherited from WalletTransactionItemBase.) | |
DisplayBalance | Gets or sets the balance on this card. (Inherited from WalletTransactionItemBase.) | |
DisplayCreditLimit | Gets or sets the card’s credit limit. (Inherited from WalletTransactionItemBase.) | |
DisplayName | Gets or sets the name or title to be displayed to the user. (Inherited from WalletItem.) | |
ExpirationDate | Gets or sets the expiration date of the wallet item. The default is null, which means the card does not expire. | |
Id | Gets the Id of the wallet item. (Inherited from WalletItem.) | |
IsAcknowledged | Gets or sets whether this item has been acknowledged by the app. Default value is false, meaning the item is new. (Inherited from WalletItem.) | |
IssuerAddress | Gets the address of the card issuer. (Inherited from WalletTransactionItemBase.) | |
IssuerName | Gets or sets the issuer name of the wallet item. (Inherited from WalletItem.) | |
IssuerPhone | Gets the phone number of the card issuer. (Inherited from WalletTransactionItemBase.) | |
IssuerWebsite | Gets or sets the full, http or https, URI for the issuer’s web site. (Inherited from WalletItem.) | |
IsUserAttentionRequired | Gets a value that indicates whether a user attention required notification is visible to the user. (Inherited from WalletItem.) | |
LastUpdated | Gets or sets the date and time the data for this item was last updated. (Inherited from WalletItem.) | |
Logo159x159 | Gets or sets the medium (159 x 159) logo of the wallet item. (Inherited from WalletItem.) | |
Logo336x336 | Gets or sets the large (336 x 336) logo of the wallet item. (Inherited from WalletItem.) | |
Logo99x99 | Gets or sets the small (99 x 99) logo of the wallet item. (Inherited from WalletItem.) | |
MemberSince | Gets or sets the date the membership began. The default value is null. | |
Message | Gets or sets the status message of the wallet item. (Inherited from WalletItem.) | |
MessageNavigationUri | Gets or sets Uri of the app to launch when the user taps the status message. (Inherited from WalletItem.) | |
NavigationUri | Gets or sets a relative URI to a page in the app. (Inherited from WalletItem.) | |
Nickname | Gets or sets a user-supplied nickname for this card. (Inherited from WalletTransactionItemBase.) | |
Notes | Gets or sets the notes for the wallet item (Inherited from WalletItem.) | |
OtherPaymentNetworks | Gets or sets the other payments networks supported by this card. | |
PaymentInstrumentKinds | Gets of sets the PaymentInstrumentKinds. | |
PaymentNetwork | Gets or sets the payment network on which this card is processed. | |
SecureElementProperties | Gets Secure Element properties for this card. (Inherited from WalletTransactionItemBase.) | |
SupportedUsages | Gets the abilities of this card, whether it can be used with NFC or to purchase in the Windows Phone Store. (Inherited from WalletTransactionItemBase.) | |
TermsAndConditions | Gets or sets the terms associated with this item. | |
TransactionHistory | Gets the ordered list of transaction history items for this card. (Inherited from WalletTransactionItemBase.) | |
TransactionHistoryNavigationUri | Gets or sets the URI that the user can navigate in order to get more transaction history. (Inherited from WalletTransactionItemBase.) | |
UserImage | Gets or sets the user image of the wallet item. (Inherited from WalletItem.) |
Top
Methods
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.) | |
NotifyActivationAuthenticationCompleted | This method is called when user authentication for item activation has been completed. (Inherited from WalletTransactionItemBase.) | |
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. (Inherited from WalletItem.) | |
SetUserAttentionRequiredNotification | Sets or clears the notification for the wallet item. (Inherited from WalletItem.) | |
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. (Inherited from WalletItem.) | |
UpdateId | Updates the Id of the wallet item. (Inherited from WalletItem.) |
Top
Remarks
For a list of all supported payment instrument types , see PaymentInstrumentKinds
Capabilities
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.
ID_CAP_WALLET |
Windows Phone 8 |
ID_CAP_WALLET_PAYMENTINSTRUMENTS |
Windows Phone 8 |
For more info, see App capabilities and hardware requirements for Windows Phone 8.
Important Note: |
---|
To deploy an app that uses the ID_CAP_WALLET_PAYMENTINSTRUMENTS capability, you must request special permissions and have that permission applied to your developer account. For more info and assistance, contact Developer support. |
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.