Class Wallet
dw.customer
Class Wallet
Object
dw.customer.Wallet
Represents a set of payment instruments associated with a registered customer.

Note: this class allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements when developing.

Properties
defaultPaymentInstrument  :  CustomerPaymentInstrument  (Read Only)
The default payment instrument associated with the related customer. If not available, returns the first payment instrument or null if no payment instruments are associated with the customer.
paymentInstruments  :  Collection  (Read Only)
A collection of all payment instruments associated with the related customer.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
createPaymentInstrument(paymentMethodId : String) : CustomerPaymentInstrument
Creates a new, empty payment instrument object associated with the related customer for the given payment method.
getDefaultPaymentInstrument() : CustomerPaymentInstrument
Returns the default payment instrument associated with the related customer.
getPaymentInstruments() : Collection
Returns a collection of all payment instruments associated with the related customer.
getPaymentInstruments(paymentMethodID : String) : Collection
Returns a collection of all payment instruments associated with the related customer filtered by the given payment method id.
removePaymentInstrument(instrument : CustomerPaymentInstrument) : void
Removes a payment instrument associated with the customer.
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
createPaymentInstrument
createPaymentInstrument(paymentMethodId : String) : CustomerPaymentInstrument
Creates a new, empty payment instrument object associated with the related customer for the given payment method.
Parameters:
paymentMethodId - the id of a payment method
Returns:
the new payment instrument object.
Throws:
NullArgumentException - If passed 'paymentMethodId' is null.
getDefaultPaymentInstrument
getDefaultPaymentInstrument() : CustomerPaymentInstrument
Returns the default payment instrument associated with the related customer. If not available, returns the first payment instrument or null if no payment instruments are associated with the customer.
Returns:
The default payment instrument object.
getPaymentInstruments
getPaymentInstruments() : Collection
Returns a collection of all payment instruments associated with the related customer.
Returns:
Collection of all payment instruments.
getPaymentInstruments
getPaymentInstruments(paymentMethodID : String) : Collection
Returns a collection of all payment instruments associated with the related customer filtered by the given payment method id. If null is passed as payment method id all payment instruments of the customer will be retrieved. If for the given payment method id no payment instrument is associated with the customer an empty collection will be returned.
Parameters:
paymentMethodID - the paymentMethodID the payment method id to filter for
Returns:
Collection of payment instruments for a payment method.
removePaymentInstrument
removePaymentInstrument(instrument : CustomerPaymentInstrument) : void
Removes a payment instrument associated with the customer.
Parameters:
instrument - the instrument associated with this customer
Throws:
NullArgumentException - If passed 'instrument' is null.
IllegalArgumentException - If passed 'instrument' belongs to an other customer
© Copyright 2000-2025, salesforce.com inc. All rights reserved. Various trademarks held by their respective owners.