Class PaymentMgr
dw.order
Class PaymentMgr
Object
dw.order.PaymentMgr
PaymentMgr is used to access payment methods and payment cards of the current site.

To access payment methods and payment cards explicitly, use methods getPaymentMethod(String) and getPaymentCard(String).

To access active payment methods use method getActivePaymentMethods().

To access applicable payment methods for a customer, country and/or payment amount use method getApplicablePaymentMethods(Customer, String, Number).

Properties
activePaymentMethods  :  List  (Read Only)
The sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions. The payment methods are sorted as defined in the Business Manager.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
static getActivePaymentMethods() : List
Returns the sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions.
static getApplicablePaymentMethods(customer : Customer, countryCode : String, paymentAmount : Number) : List
Returns the sorted list of all enabled payment methods of the current site applicable for the session currency, specified customer, country and payment amount.
static getPaymentCard(cardType : String) : PaymentCard
Returns the payment card for the specified cardType or null if no such card exists in the current site.
static getPaymentMethod(id : String) : PaymentMethod
Returns the payment method for the specified ID or null if no such method exists in the current site.
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
getActivePaymentMethods
static getActivePaymentMethods() : List
Returns the sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions. The payment methods are sorted as defined in the Business Manager.
Returns:
List of enabled payment methods of current site
getApplicablePaymentMethods
static getApplicablePaymentMethods(customer : Customer, countryCode : String, paymentAmount : Number) : List
Returns the sorted list of all enabled payment methods of the current site applicable for the session currency, specified customer, country and payment amount. The payment methods are sorted as defined in the Business Manager.

A payment method is applicable if

  • the method is restricted by customer group, and at least one of the groups of the specified customer is assigned to the method
  • the method is restricted by billing country, and the specified country code is assigned to the method
  • the method is restricted by payment amount for the session currency, and the specified payment amount is within the limits of the min/max payment amount defined for the method and the session currency
  • the method is restricted by currency code, and the specified currency code matches session currency.
All parameters are optional, and if not specified, the respective restriction won't be validated. For example, if a method is restricted by billing country, but no country code is specified, this method will be returned, unless it is filtered out by customer group or payment amount.
Parameters:
customer - Customer or null
countryCode - Billing country code or null
paymentAmount - Payment amount or null
Returns:
List of applicable payment methods of current site
getPaymentCard
static getPaymentCard(cardType : String) : PaymentCard
Returns the payment card for the specified cardType or null if no such card exists in the current site.
Parameters:
cardType - PaymentCard type
Returns:
PaymentCard or null
getPaymentMethod
static getPaymentMethod(id : String) : PaymentMethod
Returns the payment method for the specified ID or null if no such method exists in the current site.
Parameters:
id - PaymentMethod ID
Returns:
PaymentMethod or null