Class SalesforcePaymentsSiteConfiguration
Salesforce Payments representation of a payment site configuration object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.
A payment site configuration contains information about the configuration of the site such as whether the site is activated with Express Checkout, Multi-Step Checkout or both.
| Property | Description |
|---|---|
cardCaptureAutomatic: Boolean (read-only) | Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual. |
expressCheckoutEnabled: Boolean (read-only) | Returns true if Express Checkout is enabled for the site. |
expressOnCartEnabled: Boolean (read-only) | Returns true if Express Checkout is enabled on the Cart page. |
expressOnCheckoutEnabled: Boolean (read-only) | Returns true if Express Checkout is enabled on the Checkout page. |
expressOnMiniCartEnabled: Boolean (read-only) | Returns true if Express Checkout is enabled on the Mini-Cart. |
expressOnPdpEnabled: Boolean (read-only) | Returns true if Express Checkout is enabled on the Product Detail Page. |
futureUsageOffSession: Boolean (read-only) | Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials. |
multiStepCheckoutEnabled: Boolean (read-only) | Returns true if Multi-Step Checkout is enabled for the site. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| isCardCaptureAutomatic() | Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual. |
| isExpressCheckoutEnabled() | Returns true if Express Checkout is enabled for the site. |
| isExpressOnCartEnabled() | Returns true if Express Checkout is enabled on the Cart page. |
| isExpressOnCheckoutEnabled() | Returns true if Express Checkout is enabled on the Checkout page. |
| isExpressOnMiniCartEnabled() | Returns true if Express Checkout is enabled on the Mini-Cart. |
| isExpressOnPdpEnabled() | Returns true if Express Checkout is enabled on the Product Detail Page. |
| isFutureUsageOffSession() | Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials. |
| isMultiStepCheckoutEnabled() | Returns true if Multi-Step Checkout is enabled for the site. |
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
- cardCaptureAutomatic: Boolean
(read-only) Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual.
- expressCheckoutEnabled: Boolean
(read-only) Returns true if Express Checkout is enabled for the site.
- expressOnCartEnabled: Boolean
(read-only) Returns true if Express Checkout is enabled on the Cart page.
- expressOnCheckoutEnabled: Boolean
(read-only) Returns true if Express Checkout is enabled on the Checkout page.
- expressOnMiniCartEnabled: Boolean
(read-only) Returns true if Express Checkout is enabled on the Mini-Cart.
- expressOnPdpEnabled: Boolean
(read-only) Returns true if Express Checkout is enabled on the Product Detail Page.
- futureUsageOffSession: Boolean
(read-only) Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials.
- multiStepCheckoutEnabled: Boolean
(read-only) Returns true if Multi-Step Checkout is enabled for the site.
- isCardCaptureAutomatic(): Boolean
Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual.
Returns:
- true if the credit card capture method is automatic, or false if it is manual
- isExpressCheckoutEnabled(): Boolean
Returns true if Express Checkout is enabled for the site.
Returns:
- true if Express Checkout is enabled for the site, or false if not
- isExpressOnCartEnabled(): Boolean
Returns true if Express Checkout is enabled on the Cart page.
Returns:
- true if Express Checkout is enabled on Cart, or false if not
- isExpressOnCheckoutEnabled(): Boolean
Returns true if Express Checkout is enabled on the Checkout page.
Returns:
- true if Express Checkout is enabled on Checkout, or false if not
- isExpressOnMiniCartEnabled(): Boolean
Returns true if Express Checkout is enabled on the Mini-Cart.
Returns:
- true if Express Checkout is enabled on Mini-Cart, or false if not
- isExpressOnPdpEnabled(): Boolean
Returns true if Express Checkout is enabled on the Product Detail Page.
Returns:
- true if Express Checkout is enabled on PDP, or false if not
- isFutureUsageOffSession(): Boolean
Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials.
Returns:
- true if the future usage is off session, or false if on session
- isMultiStepCheckoutEnabled(): Boolean
Returns true if Multi-Step Checkout is enabled for the site.
Returns:
- true if Multi-Step Checkout is enabled for the site, or false if not