Script: Class dw.customer.CustomerPaymentInstrument

Class CustomerPaymentInstrument

Represents any payment instrument stored in the customers profile, such as credit card or bank transfer. The object defines standard methods for credit card payment, and can be extended by attributes appropriate for other payment methods.

Properties

bankAccountDriversLicense : String Read Only

The driver's license number of the bank account number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request and the current customer is registered and authenticated, and the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS

Otherwise, the method returns the masked driver's license number of the bank account.

Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.

bankAccountNumber : String Read Only

The bank account number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS

Otherwise, the method returns the masked bank account number.

Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.

creditCardNumber : String Read Only

The decrypted credit card number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS.

Otherwise, the method returns the masked credit card number.

Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getBankAccountDriversLicense() : String

Returns the driver's license number of the bank account number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request and the current customer is registered and authenticated, and the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS

Otherwise, the method returns the masked driver's license number of the bank account.

getBankAccountNumber() : String

Returns the bank account number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS

Otherwise, the method returns the masked bank account number.

getCreditCardNumber() : String

Returns the decrypted credit card number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS.

Methods inherited from class PaymentInstrument

getBankAccountDriversLicense, getBankAccountDriversLicenseLastDigits, getBankAccountDriversLicenseLastDigits, getBankAccountDriversLicenseStateCode, getBankAccountHolder, getBankAccountNumber, getBankAccountNumberLastDigits, getBankAccountNumberLastDigits, getBankRoutingNumber, getCreditCardExpirationMonth, getCreditCardExpirationYear, getCreditCardHolder, getCreditCardIssueNumber, getCreditCardNumber, getCreditCardNumberLastDigits, getCreditCardNumberLastDigits, getCreditCardToken, getCreditCardType, getCreditCardValidFromMonth, getCreditCardValidFromYear, getEncryptedBankAccountDriversLicense, getEncryptedBankAccountNumber, getEncryptedCreditCardNumber, getEncryptedCreditCardNumber, getGiftCertificateCode, getGiftCertificateID, getMaskedBankAccountDriversLicense, getMaskedBankAccountDriversLicense, getMaskedBankAccountNumber, getMaskedBankAccountNumber, getMaskedCreditCardNumber, getMaskedCreditCardNumber, getMaskedGiftCertificateCode, getMaskedGiftCertificateCode, getPaymentMethod, isCreditCardExpired, isPermanentlyMasked, setBankAccountDriversLicense, setBankAccountDriversLicenseStateCode, setBankAccountHolder, setBankAccountNumber, setBankRoutingNumber, setCreditCardExpirationMonth, setCreditCardExpirationYear, setCreditCardHolder, setCreditCardIssueNumber, setCreditCardNumber, setCreditCardToken, setCreditCardType, setCreditCardValidFromMonth, setCreditCardValidFromYear, setGiftCertificateCode, setGiftCertificateID

Methods inherited from class ExtensibleObject

describe, getCustom

Methods inherited from class PersistentObject

getCreationDate, getLastModified, getUUID

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

getBankAccountDriversLicense

getBankAccountDriversLicense() : String

Returns the driver's license number of the bank account number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request and the current customer is registered and authenticated, and the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS

Otherwise, the method returns the masked driver's license number of the bank account.

Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.

getBankAccountNumber

getBankAccountNumber() : String

Returns the bank account number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS

Otherwise, the method returns the masked bank account number.

Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.

getCreditCardNumber

getCreditCardNumber() : String

Returns the decrypted credit card number if the calling context meets the following criteria:

  • If the method call happens in the context of a storefront request, the current customer is registered and authenticated, the payment instrument is associated to the profile of the current customer, and the current protocol is HTTPS.

Otherwise, the method returns the masked credit card number.

Note: this method handles sensitive financial and card holder data. Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.