PaymentInstrument Class

May 11, 2014

A wallet item that represents a payment instrument.

Namespace:  Microsoft.Phone.Wallet
Assembly:  Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

'Declaration
Public NotInheritable Class PaymentInstrument _
	Inherits WalletTransactionItemBase
<PaymentInstrument .../>

The PaymentInstrument type exposes the following members.

  NameDescription
Public methodPaymentInstrumentInitializes a new instance of the PaymentInstrument class.
Public methodPaymentInstrument(String)Initializes a new instance of the PaymentInstrument class.
Top

  NameDescription
Public propertyAccountNumberGets or sets the account number of the card.
Public propertyBackgroundColorGets or sets the background color for the front of the card view. (Inherited from WalletTransactionItemBase.)
Public propertyBarcodeImageGets or sets an image that represents the barcode of the wallet item. (Inherited from WalletItem.)
Public propertyBillingAddressGets or sets the user’s billing address. (Inherited from WalletTransactionItemBase.)
Public propertyBillingPhoneGets or sets the user’s phone number. (Inherited from WalletTransactionItemBase.)
Public propertyCustomerNameGets or sets the customer name of the wallet item. (Inherited from WalletItem.)
Public propertyCustomPropertiesGets the collection of CustomWalletProperty objects associated with the wallet item. (Inherited from WalletItem.)
Public propertyDisplayAvailableBalanceGets or sets the card’s available balance. (Inherited from WalletTransactionItemBase.)
Public propertyDisplayAvailableCreditGets or sets the available credit on this card. (Inherited from WalletTransactionItemBase.)
Public propertyDisplayBalanceGets or sets the balance on this card. (Inherited from WalletTransactionItemBase.)
Public propertyDisplayCreditLimitGets or sets the card’s credit limit. (Inherited from WalletTransactionItemBase.)
Public propertyDisplayNameGets or sets the name or title to be displayed to the user. (Inherited from WalletItem.)
Public propertyExpirationDateGets or sets the expiration date of the wallet item. The default is null, which means the card does not expire.
Public propertyIdGets the Id of the wallet item. (Inherited from WalletItem.)
Public propertyIsAcknowledgedGets or sets whether this item has been acknowledged by the app. Default value is false, meaning the item is new. (Inherited from WalletItem.)
Public propertyIssuerAddressGets the address of the card issuer. (Inherited from WalletTransactionItemBase.)
Public propertyIssuerNameGets or sets the issuer name of the wallet item. (Inherited from WalletItem.)
Public propertyIssuerPhoneGets the phone number of the card issuer. (Inherited from WalletTransactionItemBase.)
Public propertyIssuerWebsiteGets or sets the full, http or https, URI for the issuer’s web site. (Inherited from WalletItem.)
Public propertyIsUserAttentionRequiredGets a value that indicates whether a user attention required notification is visible to the user. (Inherited from WalletItem.)
Public propertyLastUpdatedGets or sets the date and time the data for this item was last updated. (Inherited from WalletItem.)
Public propertyLogo159x159Gets or sets the medium (159 x 159) logo of the wallet item. (Inherited from WalletItem.)
Public propertyLogo336x336Gets or sets the large (336 x 336) logo of the wallet item. (Inherited from WalletItem.)
Public propertyLogo99x99Gets or sets the small (99 x 99) logo of the wallet item. (Inherited from WalletItem.)
Public propertyMemberSinceGets or sets the date the membership began. The default value is null.
Public propertyMessageGets or sets the status message of the wallet item. (Inherited from WalletItem.)
Public propertyMessageNavigationUriGets or sets Uri of the app to launch when the user taps the status message. (Inherited from WalletItem.)
Public propertyNavigationUriGets or sets a relative URI to a page in the app. (Inherited from WalletItem.)
Public propertyNicknameGets or sets a user-supplied nickname for this card. (Inherited from WalletTransactionItemBase.)
Public propertyNotesGets or sets the notes for the wallet item (Inherited from WalletItem.)
Public propertyOtherPaymentNetworksGets or sets the other payments networks supported by this card.
Public propertyPaymentInstrumentKindsGets of sets the PaymentInstrumentKinds.
Public propertyPaymentNetworkGets or sets the payment network on which this card is processed.
Public propertySecureElementPropertiesGets Secure Element properties for this card. (Inherited from WalletTransactionItemBase.)
Public propertySupportedUsagesGets the abilities of this card, whether it can be used with NFC or to purchase in the Windows Phone Store. (Inherited from WalletTransactionItemBase.)
Public propertyTermsAndConditionsGets or sets the terms associated with this item.
Public propertyTransactionHistoryGets the ordered list of transaction history items for this card. (Inherited from WalletTransactionItemBase.)
Public propertyTransactionHistoryNavigationUriGets or sets the URI that the user can navigate in order to get more transaction history. (Inherited from WalletTransactionItemBase.)
Public propertyUserImageGets or sets the user image of the wallet item. (Inherited from WalletItem.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodNotifyActivationAuthenticationCompletedThis method is called when user authentication for item activation has been completed. (Inherited from WalletTransactionItemBase.)
Public methodSaveAsyncAsynchronously 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.)
Public methodSetUserAttentionRequiredNotificationSets or clears the notification for the wallet item. (Inherited from WalletItem.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUndoUndoes all changes to the wallet item since the last time SaveAsync was called. (Inherited from WalletItem.)
Public methodUpdateIdUpdates the Id of the wallet item. (Inherited from WalletItem.)
Top

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 noteImportant 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.

Windows Phone OS

Supported in: 8.1, 8.0

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

Show:
© 2014 Microsoft