Class SalesforcePaymentMethod

• TopLevel.Object
  • dw.extensions.payments.SalesforcePaymentMethod

Salesforce Payments representation of a payment method object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.

A payment method contains information about a credential used by a shopper to attempt payment, such as a payment card or bank account. The available information differs for each type of payment method. It includes only limited information that can be safely presented to a shopper to remind them what credential they used, and specifically not complete card, account, or other numbers that could be used to make future payments.

Constant Summary 

Constant	Description
TYPE_AFTERPAY_CLEARPAY: String = “afterpay_clearpay”	Represents the Afterpay Clearpay payment method.
TYPE_BANCONTACT: String = “bancontact”	Represents the Bancontact payment method.
TYPE_CARD: String = “card”	Represents a credit card type of payment method.
TYPE_EPS: String = “eps”	Represents the EPS (Electronic Payment Standard) payment method.
TYPE_IDEAL: String = “ideal”	Represents the iDEAL payment method.
TYPE_KLARNA: String = “klarna”	Represents the Klarna payment method.
TYPE_SEPA_DEBIT: String = “sepa_debit”	Represents the SEPA Debit payment method.

Property Summary 

Property	Description
ID: String (read-only)	Returns the identifier of this payment method.
bank: String (read-only)	Returns the bank of this payment method, or null if none is available.
bankCode: String (read-only)	Returns the bank code of this payment method, or null if none is available.
bankName: String (read-only)	Returns the bank name of this payment method, or null if none is available.
branchCode: String (read-only)	Returns the bank branch code of this payment method, or null if none is available.
brand: String (read-only)	Returns the brand of this payment method, or null if none is available.
country: String (read-only)	Returns the country of this payment method, or null if none is available.
last4: String (read-only)	Returns the last 4 digits of the credential for this payment method, or null if none is available.
paymentMethodCategory: String (read-only)	Returns the payment method category of this payment method, or null if none is available.
type: String (read-only)	Returns the type of this payment method.

Constructor Summary 

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

Method Summary 

Method	Description
getBank()	Returns the bank of this payment method, or null if none is available.
getBankCode()	Returns the bank code of this payment method, or null if none is available.
getBankName()	Returns the bank name of this payment method, or null if none is available.
getBranchCode()	Returns the bank branch code of this payment method, or null if none is available.
getBrand()	Returns the brand of this payment method, or null if none is available.
getCountry()	Returns the country of this payment method, or null if none is available.
getID()	Returns the identifier of this payment method.
getLast4()	Returns the last 4 digits of the credential for this payment method, or null if none is available.
getPaymentDetails(OrderPaymentInstrument)	Returns the details to the Salesforce Payments payment for this payment method, using the given payment instrument.
getPaymentMethodCategory()	Returns the payment method category of this payment method, or null if none is available.
getType()	Returns the type of this payment method.

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

Constant Details 

TYPE_AFTERPAY_CLEARPAY 

TYPE_AFTERPAY_CLEARPAY: String = "afterpay_clearpay"

Represents the Afterpay Clearpay payment method.

---

TYPE_BANCONTACT 

TYPE_BANCONTACT: String = "bancontact"

Represents the Bancontact payment method.

---

TYPE_CARD 

TYPE_CARD: String = "card"

Represents a credit card type of payment method.

---

TYPE_EPS 

TYPE_EPS: String = "eps"

Represents the EPS (Electronic Payment Standard) payment method.

---

TYPE_IDEAL 

TYPE_IDEAL: String = "ideal"

Represents the iDEAL payment method.

---

TYPE_KLARNA 

TYPE_KLARNA: String = "klarna"

Represents the Klarna payment method.

---

TYPE_SEPA_DEBIT 

TYPE_SEPA_DEBIT: String = "sepa_debit"

Represents the SEPA Debit payment method.

---

Property Details 

ID 

ID: String (read-only)

Returns the identifier of this payment method.

---

bank 

bank: String (read-only)

Returns the bank of this payment method, or null if none is available. Available on TYPE_IDEAL and TYPE_EPS type methods.

---

bankCode 

bankCode: String (read-only)

Returns the bank code of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT and TYPE_BANCONTACT type methods.

---

bankName 

bankName: String (read-only)

Returns the bank name of this payment method, or null if none is available. Available on TYPE_BANCONTACT type methods.

---

branchCode 

branchCode: String (read-only)

Returns the bank branch code of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT type methods.

---

brand 

brand: String (read-only)

Returns the brand of this payment method, or null if none is available. Available on TYPE_CARD type methods.

---

country 

country: String (read-only)

Returns the country of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT type methods.

---

last4 

last4: String (read-only)

Returns the last 4 digits of the credential for this payment method, or null if none is available. Available on TYPE_CARD, TYPE_SEPA_DEBIT, and TYPE_BANCONTACT type methods.

---

paymentMethodCategory 

paymentMethodCategory: String (read-only)

Returns the payment method category of this payment method, or null if none is available. Available on TYPE_KLARNA type methods.

---

type 

type: String (read-only)

Returns the type of this payment method.

See Also:

• TYPE_BANCONTACT
• TYPE_CARD
• TYPE_EPS
• TYPE_AFTERPAY_CLEARPAY
• TYPE_IDEAL
• TYPE_SEPA_DEBIT

---

Method Details 

getBank() 

getBank(): String

Returns the bank of this payment method, or null if none is available. Available on TYPE_IDEAL and TYPE_EPS type methods.

Returns:

• payment method bank

---

getBankCode() 

getBankCode(): String

Returns the bank code of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT and TYPE_BANCONTACT type methods.

Returns:

• payment method bank code

---

getBankName() 

getBankName(): String

Returns the bank name of this payment method, or null if none is available. Available on TYPE_BANCONTACT type methods.

Returns:

• payment method bank name

---

getBranchCode() 

getBranchCode(): String

Returns the bank branch code of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT type methods.

Returns:

• payment method bank branch code

---

getBrand() 

getBrand(): String

Returns the brand of this payment method, or null if none is available. Available on TYPE_CARD type methods.

Returns:

• payment method brand

---

getCountry() 

getCountry(): String

Returns the country of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT type methods.

Returns:

• payment method country

---

getID() 

getID(): String

Returns the identifier of this payment method.

Returns:

• payment method identifier

---

getLast4() 

getLast4(): String

Returns the last 4 digits of the credential for this payment method, or null if none is available. Available on TYPE_CARD, TYPE_SEPA_DEBIT, and TYPE_BANCONTACT type methods.

Returns:

• payment method credential last 4 digits

---

getPaymentDetails(OrderPaymentInstrument) 

getPaymentDetails(paymentInstrument: OrderPaymentInstrument): SalesforcePaymentDetails

Returns the details to the Salesforce Payments payment for this payment method, using the given payment instrument.

Parameters:

• paymentInstrument - payment instrument

Returns:

• The payment details

---

getPaymentMethodCategory() 

getPaymentMethodCategory(): String

Returns the payment method category of this payment method, or null if none is available. Available on TYPE_KLARNA type methods.

Returns:

• payment method category

---

getType() 

getType(): String

Returns the type of this payment method.

Returns:

• payment method type

See Also:

• TYPE_BANCONTACT
• TYPE_CARD
• TYPE_EPS
• TYPE_AFTERPAY_CLEARPAY
• TYPE_IDEAL
• TYPE_SEPA_DEBIT

---