Class SalesforcePaymentRequest

Salesforce Payments request for a shopper to make payment. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.

A request is required to render payment methods and/or express checkout buttons using <ispayment> or <isbuynow>. You can call methods on the payment request to configure which payment methods and/or express checkout buttons may be presented, and customize their visual presentation.

When used with <isbuynow> you must provide the necessary data to prepare the shopper basket to buy the product, and the necessary payment request options for the browser payment app.

Constant Summary 
ConstantDescription
ELEMENT_AFTERPAY_CLEARPAY_MESSAGE: String = “afterpayClearpayMessage”Element for the Stripe Afterpay/Clearpay message "afterpayClearpayMessage".
ELEMENT_CARD_CVC: String = “cardCvc”Element for the Stripe credit card CVC field "cardCvc".
ELEMENT_CARD_EXPIRY: String = “cardExpiry”Element for the Stripe credit card expiration date field "cardExpiry".
ELEMENT_CARD_NUMBER: String = “cardNumber”Element for the Stripe credit card number field "cardNumber".
ELEMENT_EPS_BANK: String = “epsBank”Element for the Stripe EPS bank selection field "epsBank".
ELEMENT_IBAN: String = “iban”Element for the Stripe IBAN field "iban".
ELEMENT_IDEAL_BANK: String = “idealBank”Element for the Stripe iDEAL bank selection field "idealBank".
ELEMENT_PAYMENT_REQUEST_BUTTON: String = “paymentRequestButton”Element for the Stripe payment request button "paymentRequestButton".
ELEMENT_TYPE_AFTERPAY_CLEARPAY: String = “afterpay_clearpay”Element type name for Afterpay.
ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE: String = “afterpayclearpaymessage”Element type name for Afterpay/Clearpay message.
ELEMENT_TYPE_APPLEPAY: String = “applepay”Element type name for Apple Pay payment request buttons.
ELEMENT_TYPE_BANCONTACT: String = “bancontact”Element type name for Bancontact.
ELEMENT_TYPE_CARD: String = “card”Element type name for credit cards.
ELEMENT_TYPE_EPS: String = “eps”Element type name for EPS.
ELEMENT_TYPE_IDEAL: String = “ideal”Element type name for iDEAL.
ELEMENT_TYPE_PAYMENTREQUEST: String = “paymentrequest”Element type name for other payment request buttons besides Apple Pay, like Google Pay.
ELEMENT_TYPE_PAYPAL: String = “paypal”Element type name for PayPal in multi-step checkout.
ELEMENT_TYPE_PAYPAL_EXPRESS: String = “paypalexpress”Element type name for PayPal in express checkout.
ELEMENT_TYPE_PAYPAL_MESSAGE: String = “paypalmessage”Element type name for the PayPal messages component.
ELEMENT_TYPE_SEPA_DEBIT: String = “sepa_debit”Element type name for SEPA debit.
ELEMENT_TYPE_VENMO: String = “venmo”Element type name for Venmo in multi-step checkout.
ELEMENT_TYPE_VENMO_EXPRESS: String = “venmoexpress”Element type name for Venmo in express checkout.
PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE: String = “GET_FROM_FILE”PayPal application context shipping_preference value "GET_FROM_FILE", to use the customer-provided shipping address on the PayPal site.
PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING: String = “NO_SHIPPING”PayPal application context shipping_preference value "NO_SHIPPING", to redact the shipping address from the PayPal site.
PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS: String = “SET_PROVIDED_ADDRESS”PayPal application context shipping_preference value "SET_PROVIDED_ADDRESS", to use the merchant-provided address.
PAYPAL_USER_ACTION_CONTINUE: String = “CONTINUE”PayPal application context user_action value "CONTINUE".
PAYPAL_USER_ACTION_PAY_NOW: String = “PAY_NOW”PayPal application context user_action value "PAY_NOW".

Property Summary 
PropertyDescription
ID: String (read-only)Returns the identifier of this payment request.
basketData: ObjectReturns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.
billingDetails: ObjectReturns a JS object containing the billing details to use when a Stripe PaymentMethod is created.
cardCaptureAutomatic: BooleanReturns true if the credit card payment should be automatically captured at the time of the sale, or false if the credit card payment should be captured later.
exclude: Set (read-only)

Returns a set containing the element types to be explicitly excluded from mounted components.

include: Set (read-only)

Returns a set containing the specific element types to include in mounted components.

selector: String (read-only)Returns the DOM element selector where to mount payment methods and/or express checkout buttons.
setupFutureUsage: BooleanReturns true if the payment method should be always saved for future use off session, or false if the payment method should be only saved for future use on session when appropriate.
statementDescriptor: StringReturns the complete description that appears on your customers’ statements for payments made by this request, or null if the default statement descriptor for your account will be used.

Constructor Summary 
ConstructorDescription
SalesforcePaymentRequest(String, String)Constructs a payment request using the given identifiers.

Method Summary 
MethodDescription
addExclude(String)

Adds the given element type to explicitly exclude from mounted components.

addInclude(String)

Adds the given element type to include in mounted components.

static calculatePaymentRequestOptions(Basket, Object)

Returns a JS object containing the payment request options to use when a Pay Now button is tapped, in the appropriate format for use in client side JavaScript, with data calculated from the given basket.

static format(Object)

Returns a JS object containing the payment request options to use when a Buy Now button is tapped, in the appropriate format for use in client side JavaScript.

getBasketData()Returns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.
getBillingDetails()Returns a JS object containing the billing details to use when a Stripe PaymentMethod is created.
getCardCaptureAutomatic()Returns true if the credit card payment should be automatically captured at the time of the sale, or false if the credit card payment should be captured later.
getExclude()

Returns a set containing the element types to be explicitly excluded from mounted components.

getID()Returns the identifier of this payment request.
getInclude()

Returns a set containing the specific element types to include in mounted components.

getSelector()Returns the DOM element selector where to mount payment methods and/or express checkout buttons.
getSetupFutureUsage()Returns true if the payment method should be always saved for future use off session, or false if the payment method should be only saved for future use on session when appropriate.
getStatementDescriptor()Returns the complete description that appears on your customers’ statements for payments made by this request, or null if the default statement descriptor for your account will be used.
setBasketData(Object)

Sets the data used to prepare the shopper basket when a Buy Now button is tapped.

setBillingDetails(Object)Sets the billing details to use when a Stripe PaymentMethod is created.
setCardCaptureAutomatic(Boolean)Sets if the credit card payment should be automatically captured at the time of the sale.
setOptions(Object)

Sets the payment request options to use when a Buy Now button is tapped.

setPayPalButtonsOptions(Object)Sets the the options to pass into the paypal.Buttons call.
setPayPalShippingPreference(String)Sets the PayPal order application context shipping_preference value.
setPayPalUserAction(String)Sets the PayPal order application context user_action value.
setReturnController(String)Sets the controller to which to redirect when the shopper returns from a 3rd party payment website.
setSavePaymentMethodEnabled(Boolean)Sets if mounted components may provide a control for the shopper to save their payment method for later use.
setSetupFutureUsage(Boolean)Sets if the payment method should be always saved for future use off session.
setStatementDescriptor(String)Sets the complete description that appears on your customers’ statements for payments made by this request.
setStripeCreateElementOptions(String, Object)Sets the the options to pass into the Stripe elements.create call for the given element type.
setStripeElementsOptions(Object)Sets the the options to pass into the stripe.elements call.

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 

ELEMENT_AFTERPAY_CLEARPAY_MESSAGE 
ELEMENT_AFTERPAY_CLEARPAY_MESSAGE: String = "afterpayClearpayMessage"

Element for the Stripe Afterpay/Clearpay message "afterpayClearpayMessage".

ELEMENT_CARD_CVC 
ELEMENT_CARD_CVC: String = "cardCvc"

Element for the Stripe credit card CVC field "cardCvc".

ELEMENT_CARD_EXPIRY 
ELEMENT_CARD_EXPIRY: String = "cardExpiry"

Element for the Stripe credit card expiration date field "cardExpiry".

ELEMENT_CARD_NUMBER 
ELEMENT_CARD_NUMBER: String = "cardNumber"

Element for the Stripe credit card number field "cardNumber".

ELEMENT_EPS_BANK 
ELEMENT_EPS_BANK: String = "epsBank"

Element for the Stripe EPS bank selection field "epsBank".

ELEMENT_IBAN 
ELEMENT_IBAN: String = "iban"

Element for the Stripe IBAN field "iban".

ELEMENT_IDEAL_BANK 
ELEMENT_IDEAL_BANK: String = "idealBank"

Element for the Stripe iDEAL bank selection field "idealBank".

ELEMENT_PAYMENT_REQUEST_BUTTON 
ELEMENT_PAYMENT_REQUEST_BUTTON: String = "paymentRequestButton"

Element for the Stripe payment request button "paymentRequestButton".

ELEMENT_TYPE_AFTERPAY_CLEARPAY 
ELEMENT_TYPE_AFTERPAY_CLEARPAY: String = "afterpay_clearpay"

Element type name for Afterpay.

ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE 
ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE: String = "afterpayclearpaymessage"

Element type name for Afterpay/Clearpay message.

ELEMENT_TYPE_APPLEPAY 
ELEMENT_TYPE_APPLEPAY: String = "applepay"

Element type name for Apple Pay payment request buttons.

ELEMENT_TYPE_BANCONTACT 
ELEMENT_TYPE_BANCONTACT: String = "bancontact"

Element type name for Bancontact.

ELEMENT_TYPE_CARD 
ELEMENT_TYPE_CARD: String = "card"

Element type name for credit cards.

ELEMENT_TYPE_EPS 
ELEMENT_TYPE_EPS: String = "eps"

Element type name for EPS.

ELEMENT_TYPE_IDEAL 
ELEMENT_TYPE_IDEAL: String = "ideal"

Element type name for iDEAL.

ELEMENT_TYPE_PAYMENTREQUEST 
ELEMENT_TYPE_PAYMENTREQUEST: String = "paymentrequest"

Element type name for other payment request buttons besides Apple Pay, like Google Pay.

ELEMENT_TYPE_PAYPAL 
ELEMENT_TYPE_PAYPAL: String = "paypal"

Element type name for PayPal in multi-step checkout.

ELEMENT_TYPE_PAYPAL_EXPRESS 
ELEMENT_TYPE_PAYPAL_EXPRESS: String = "paypalexpress"

Element type name for PayPal in express checkout.

ELEMENT_TYPE_PAYPAL_MESSAGE 
ELEMENT_TYPE_PAYPAL_MESSAGE: String = "paypalmessage"

Element type name for the PayPal messages component.

ELEMENT_TYPE_SEPA_DEBIT 
ELEMENT_TYPE_SEPA_DEBIT: String = "sepa_debit"

Element type name for SEPA debit.

ELEMENT_TYPE_VENMO 
ELEMENT_TYPE_VENMO: String = "venmo"

Element type name for Venmo in multi-step checkout.

ELEMENT_TYPE_VENMO_EXPRESS 
ELEMENT_TYPE_VENMO_EXPRESS: String = "venmoexpress"

Element type name for Venmo in express checkout.

PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE 
PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE: String = "GET_FROM_FILE"

PayPal application context shipping_preference value "GET_FROM_FILE", to use the customer-provided shipping address on the PayPal site.

PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING 
PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING: String = "NO_SHIPPING"

PayPal application context shipping_preference value "NO_SHIPPING", to redact the shipping address from the PayPal site. Recommended for digital goods.

PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS 
PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS: String = "SET_PROVIDED_ADDRESS"

PayPal application context shipping_preference value "SET_PROVIDED_ADDRESS", to use the merchant-provided address. The customer cannot change this address on the PayPal site.

PAYPAL_USER_ACTION_CONTINUE 
PAYPAL_USER_ACTION_CONTINUE: String = "CONTINUE"

PayPal application context user_action value "CONTINUE". Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.

PAYPAL_USER_ACTION_PAY_NOW 
PAYPAL_USER_ACTION_PAY_NOW: String = "PAY_NOW"

PayPal application context user_action value "PAY_NOW". Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.

Property Details 

ID 
ID: String (read-only)

Returns the identifier of this payment request.

basketData 
basketData: Object

Returns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.

See Also:

billingDetails 
billingDetails: Object

Returns a JS object containing the billing details to use when a Stripe PaymentMethod is created.

See Also:

cardCaptureAutomatic 
cardCaptureAutomatic: Boolean

Returns true if the credit card payment should be automatically captured at the time of the sale, or false if the credit card payment should be captured later.

exclude 
exclude: Set (read-only)

Returns a set containing the element types to be explicitly excluded from mounted components. See the element type constants in this class for the full list of supported element types.

Note: if an element type is both explicitly included and excluded, it will not be presented.

See Also:

include 
include: Set (read-only)

Returns a set containing the specific element types to include in mounted components. If the set is empty then all applicable and enabled element types will be included by default. See the element type constants in this class for the full list of supported element types.

Note: if an element type is both explicitly included and excluded, it will not be presented.

See Also:

selector 
selector: String (read-only)

Returns the DOM element selector where to mount payment methods and/or express checkout buttons.

setupFutureUsage 
setupFutureUsage: Boolean

Returns true if the payment method should be always saved for future use off session, or false if the payment method should be only saved for future use on session when appropriate.

statementDescriptor 
statementDescriptor: String

Returns the complete description that appears on your customers' statements for payments made by this request, or null if the default statement descriptor for your account will be used.

Constructor Details 

SalesforcePaymentRequest(String, String) 
SalesforcePaymentRequest(id: String, selector: String)

Constructs a payment request using the given identifiers.

Parameters:

  • id - identifier for payment request
  • selector - DOM element selector where to mount payment methods and/or express checkout buttons

Throws:

  • Exception - if id or selector is null

Method Details 

addExclude(String) 
addExclude(elementType: String): void

Adds the given element type to explicitly exclude from mounted components. It is not necessary to explicitly exclude element types that are not enabled for the site, or are not applicable for the current shopper and/or their basket. See the element type constants in this class for the full list of supported element types.

Note: if an element type is both explicitly included and excluded, it will not be presented.

Parameters:

  • elementType - element type

See Also:

addInclude(String) 
addInclude(elementType: String): void

Adds the given element type to include in mounted components. Call this method to include only a specific list of element types to be presented when applicable and enabled for the site. See the element type constants in this class for the full list of supported element types.

Note: if an element type is both explicitly included and excluded, it will not be presented.

Parameters:

  • elementType - element type

See Also:

calculatePaymentRequestOptions(Basket, Object) 
static calculatePaymentRequestOptions(basket: Basket, options: Object): Object

Returns a JS object containing the payment request options to use when a Pay Now button is tapped, in the appropriate format for use in client side JavaScript, with data calculated from the given basket. This method is provided as a convenience to calculate updated payment request options when the shopper basket has changed. Data in the given options object like total, displayItems, and shippingOptions will be replaced in the returned object by values recalculated from the given basket and applicable shipping methods.

The following example shows the resulting output for a basket and sample options.

1SalesforcePaymentRequest.calculatePaymentRequestOptions(basket, {
2   requestPayerName: true,
3   requestPayerEmail: true,
4   requestPayerPhone: false,
5   requestShipping: true
6});

returns

1{
2   currency: 'gbp',
3   total: {
4       label: 'Total',
5       amount: '2644'
6   },
7   displayItems: [{
8       label: 'Subtotal',
9       amount: '1919'
10   }, {
11       label: 'Tax',
12       amount: '126'
13   }, {
14       label: 'Ground',
15       amount: '599'
16   }],
17   requestPayerName: true,
18   requestPayerEmail: true,
19   requestPayerPhone: false,
20   requestShipping: true,
21   shippingOptions: [{
22       id: 'GBP001',
23       label: 'Ground',
24       detail: 'Order received within 7-10 business days',
25       amount: '599'
26   },{
27       id: 'GBP002',
28       label: 'Express',
29       detail: 'Order received within 2-4 business days',
30       amount: '999'
31   }]
32}

Parameters:

  • options - JS object containing payment request options in B2C Commerce API standard format

Returns:

  • JS object containing equivalent payment request options in Stripe JS API format

format(Object) 
static format(options: Object): Object

Returns a JS object containing the payment request options to use when a Buy Now button is tapped, in the appropriate format for use in client side JavaScript. This method is provided as a convenience to adjust values in B2C Commerce API standard formats to their equivalents as expected by Stripe JS APIs. The following example shows options set in B2C Commerce API format, and the resulting output.

1SalesforcePaymentRequest.format({
2   currency: 'GBP',
3   total: {
4       label: 'Total',
5       amount: '26.44'
6   },
7   displayItems: [{
8       label: 'Subtotal',
9       amount: '19.19'
10   }, {
11       label: 'Tax',
12       amount: '1.26'
13   }, {
14       label: 'Ground',
15       amount: '5.99'
16   }],
17   requestPayerPhone: false,
18   shippingOptions: [{
19       id: 'GBP001',
20       label: 'Ground',
21       detail: 'Order received within 7-10 business days',
22       amount: '5.99'
23   }]
24});

returns

1{
2   currency: 'gbp',
3   total: {
4       label: 'Total',
5       amount: '2644'
6   },
7   displayItems: [{
8       label: 'Subtotal',
9       amount: '1919'
10   }, {
11       label: 'Tax',
12       amount: '126'
13   }, {
14       label: 'Ground',
15       amount: '599'
16   }],
17   requestPayerPhone: false,
18   shippingOptions: [{
19       id: 'GBP001',
20       label: 'Ground',
21       detail: 'Order received within 7-10 business days',
22       amount: '599'
23   }]
24}

Parameters:

  • options - JS object containing payment request options in B2C Commerce API standard format

Returns:

  • JS object containing equivalent payment request options in Stripe JS API format

getBasketData() 
getBasketData(): Object

Returns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.

Returns:

  • JS object containing the basket data

See Also:

getBillingDetails() 
getBillingDetails(): Object

Returns a JS object containing the billing details to use when a Stripe PaymentMethod is created.

Returns:

  • JS object containing the billing details

See Also:

getCardCaptureAutomatic() 
getCardCaptureAutomatic(): Boolean

Returns true if the credit card payment should be automatically captured at the time of the sale, or false if the credit card payment should be captured later.

Returns:

  • true if the credit card payment should be automatically captured at the time of the sale, false if the credit card payment should be captured later.

getExclude() 
getExclude(): Set

Returns a set containing the element types to be explicitly excluded from mounted components. See the element type constants in this class for the full list of supported element types.

Note: if an element type is both explicitly included and excluded, it will not be presented.

Returns:

  • set of element types

See Also:

getID() 
getID(): String

Returns the identifier of this payment request.

Returns:

  • payment request identifier

getInclude() 
getInclude(): Set

Returns a set containing the specific element types to include in mounted components. If the set is empty then all applicable and enabled element types will be included by default. See the element type constants in this class for the full list of supported element types.

Note: if an element type is both explicitly included and excluded, it will not be presented.

Returns:

  • set of element types

See Also:

getSelector() 
getSelector(): String

Returns the DOM element selector where to mount payment methods and/or express checkout buttons.

Returns:

  • DOM element selector

getSetupFutureUsage() 
getSetupFutureUsage(): Boolean

Returns true if the payment method should be always saved for future use off session, or false if the payment method should be only saved for future use on session when appropriate.

Returns:

  • true if the payment method should be always saved for future use off session, false if the payment method should be only saved for future use on session when appropriate.

getStatementDescriptor() 
getStatementDescriptor(): String

Returns the complete description that appears on your customers' statements for payments made by this request, or null if the default statement descriptor for your account will be used.

Returns:

  • statement descriptor for payments made by this request, or null if the account default will be used

setBasketData(Object) 
setBasketData(basketData: Object): void

Sets the data used to prepare the shopper basket when a Buy Now button is tapped. For convenience this method accepts a JS object to set all of the following properties at once:

  • sku- SKU of the product to add exclusively to the basket (required)
  • quantity- integer quantity of the product, default is 1
  • shippingMethod- ID of the shipping method to set on the shipment, default is the site default shipping method for the basket currency
  • options- JS array containing one JS object per selected product option, default is no selected options
    • id- product option ID
    • valueId- product option value ID

The following example shows how to set all of the supported basket data.

1```
2request.setBasketData({
3   sku: 'tv-pdp-6010fdM',
4   quantity: 1,
5   shippingMethod: '001',
6   options: [{
7       id: 'tvWarranty',
8       valueId: '000'
9   }]
10});
11```

Parameters:

  • basketData - JS object containing the basket data

See Also:

setBillingDetails(Object) 
setBillingDetails(billingDetails: Object): void

Sets the billing details to use when a Stripe PaymentMethod is created. For convenience this method accepts a JS object to set all details at once. The following example shows how to set details including address.

1request.setBillingDetails({
2   address: {
3       city: 'Wien',
4       country: 'AT',
5       line1: 'Opernring 2',
6       postal_code: '1010'
7   },
8   email: 'jhummel@salesforce.com',
9   name: 'Johann Hummel'
10});

For more information on the available billing details see the Stripe create PaymentMethod API documentation.

Parameters:

  • billingDetails - JS object containing the billing details

setCardCaptureAutomatic(Boolean) 
setCardCaptureAutomatic(cardCaptureAutomatic: Boolean): void

Sets if the credit card payment should be automatically captured at the time of the sale.

Parameters:

  • cardCaptureAutomatic - true if the credit card payment should be automatically captured at the time of the sale, or false if the credit card payment should be captured later.

setOptions(Object) 
setOptions(options: Object): void

Sets the payment request options to use when a Buy Now button is tapped. For convenience this method accepts a JS object to set all options at once. The following example shows how to set options including currency, labels, and amounts, in B2C Commerce API format.

1request.setOptions({
2   currency: 'GBP',
3   total: {
4       label: 'Total',
5       amount: '26.44'
6   },
7   displayItems: [{
8       label: 'Subtotal',
9       amount: '19.19'
10   }, {
11       label: 'Tax',
12       amount: '1.26'
13   }, {
14       label: 'Ground',
15       amount: '5.99'
16   }],
17   requestPayerPhone: false,
18   shippingOptions: [{
19       id: 'GBP001',
20       label: 'Ground',
21       detail: 'Order received within 7-10 business days',
22       amount: '5.99'
23   }]
24});

The total option must match the total that will result from preparing the shopper basket using the data provided to setBasketData(Object) in this request. The id of each JS object in the shippingOptions array must equal the ID of the corresponding site shipping method that the shopper may select in the browser payment app.

For more information on the available payment request options see the Stripe Payment Request object API documentation.

Note: The Stripe Payment Request country option will be set automatically to the country of the Salesforce Payments account associated with the Commerce Cloud instance and is not included here.

Parameters:

  • options - JS object containing the payment request options

setPayPalButtonsOptions(Object) 
setPayPalButtonsOptions(options: Object): void

Sets the the options to pass into the paypal.Buttons call. For more information see the PayPal Buttons API documentation.

Parameters:

  • options - JS object containing the options

setPayPalShippingPreference(String) 
setPayPalShippingPreference(shippingPreference: String): void

Sets the PayPal order application context shipping_preference value. For more information see the PayPal Orders API documentation.

Parameters:

  • shippingPreference - constant indicating the shipping preference

See Also:

setPayPalUserAction(String) 
setPayPalUserAction(userAction: String): void

Sets the PayPal order application context user_action value. For more information see the PayPal Orders API documentation.

Parameters:

  • userAction - constant indicating the user action

See Also:

setReturnController(String) 
setReturnController(returnController: String): void

Sets the controller to which to redirect when the shopper returns from a 3rd party payment website. Default is the controller for the current page.

Parameters:

  • returnController - return controller, such as "Cart-Show"

setSavePaymentMethodEnabled(Boolean) 
setSavePaymentMethodEnabled(savePaymentMethodEnabled: Boolean): void

Sets if mounted components may provide a control for the shopper to save their payment method for later use. When set to false no control will be provided. When set to true a control may be provided, if applicable for the shopper and presented payment method, but is not guaranteed.

Parameters:

  • savePaymentMethodEnabled - if mounted components may provide a control for the shopper to save their payment method

setSetupFutureUsage(Boolean) 
setSetupFutureUsage(setupFutureUsage: Boolean): void

Sets if the payment method should be always saved for future use off session.

Parameters:

  • setupFutureUsage - true if the payment method should be always saved for future use off session, or false if the payment method should be only saved for future use on session when appropriate.

setStatementDescriptor(String) 
setStatementDescriptor(statementDescriptor: String): void

Sets the complete description that appears on your customers' statements for payments made by this request. Set this to null to use the default statement descriptor for your account.

Parameters:

  • statementDescriptor - statement descriptor for payments made by this request, or null to use the account default

setStripeCreateElementOptions(String, Object) 
setStripeCreateElementOptions(element: String, options: Object): void

Sets the the options to pass into the Stripe elements.create call for the given element type. For more information see the Stripe Elements API documentation.

Parameters:

  • element - name of the Stripe element whose creation to configure
  • options - JS object containing the options

See Also:

setStripeElementsOptions(Object) 
setStripeElementsOptions(options: Object): void

Sets the the options to pass into the stripe.elements call. For more information see the Stripe Elements API documentation.

Parameters:

  • options - JS object containing the options

Open Commerce API (deprecated)
Shop Baskets (deprecated)
Shop Categories (deprecated)
Shop Content (deprecated)
Shop Content Search (deprecated)
Shop Custom Objects (deprecated)
Shop Customers (deprecated)
Shop Folders (deprecated)
Shop Gift Certificate (deprecated)
Shop Order Search (deprecated)
Shop Orders (deprecated)
Shop Price Adjustment Limits (deprecated)
Shop Product Lists (deprecated)
Shop Product Search (deprecated)
Shop Products (deprecated)
Shop Promotions (deprecated)
Shop Search Suggestion (deprecated)
Shop Sessions (deprecated)
Shop Site (deprecated)
Shop Stores (deprecated)
Data A/B Test Search (deprecated)
Data A/B Tests (deprecated)
Data Alerts (deprecated)
Data Campaign Search (deprecated)
Data Campaigns (deprecated)
Data Cartridges (deprecated)
Data Catalog Search (deprecated)
Data Catalogs (deprecated)
Data Category Search (deprecated)
Data Code Versions (deprecated)
Data Coupon Redemption Search (deprecated)
Data Coupon Search (deprecated)
Data Coupons (deprecated)
Data Custom Object Definitions (deprecated)
Data Custom Objects (deprecated)
Data Custom Objects Search (deprecated)
Data Customer Group Search (deprecated)
Data Customer Groups (deprecated)
Data Customer Lists (deprecated)
Data Gift Certificate Search (deprecated)
Data Gift Certificates (deprecated)
Data Global Custom Objects (deprecated)
Data Global Locale Info (deprecated)
Data Global Preferences (deprecated)
Data Global Site Preferences (deprecated)
Data Inventory List Search (deprecated)
Data Inventory Lists (deprecated)
Data Job Execution Search (deprecated)
Data Jobs (deprecated)
Data Libraries (deprecated)
Data Locale Info (deprecated)
Data Log Requests (deprecated)
Data Metrics (deprecated)
Data OCAPI Configs (deprecated)
Data Orders (deprecated)
Data Permissions (deprecated)
Data Product Search (deprecated)
Data Products (deprecated)
Data Promotion Campaign Assignment Search (deprecated)
Data Promotion Search (deprecated)
Data Promotions (deprecated)
Data Recommender Names (deprecated)
Data Role Search (deprecated)
Data Roles (deprecated)
Data Settings (deprecated)
Data Site Preferences (deprecated)
Data Site Search (deprecated)
Data Sites (deprecated)
Data Slot Configuration Campaign Assignment Search (deprecated)
Data Slot Configuration Search (deprecated)
Data Slot Configurations (deprecated)
Data Slot Search (deprecated)
Data Slots (deprecated)
Data Sorting Rule Search (deprecated)
Data Source Code Group Search (deprecated)
Data Source Code Groups (deprecated)
Data Store Search (deprecated)
Data Stores (deprecated)
Data System Object Definition Search (deprecated)
Data System Object Definitions (deprecated)
Data User Search (deprecated)
Data Users (deprecated)
Script API
B2C Commerce Script API 26.4
TopLevel
dw.alert
dw.campaign
dw.catalog
dw.content
dw.crypto
dw.customer
dw.customer.oauth
dw.customer.shoppercontext
dw.experience
dw.experience.cms
dw.experience.image
dw.extensions.applepay
dw.extensions.facebook
dw.extensions.paymentapi
dw.extensions.paymentrequest
dw.extensions.payments
SalesforceAdyenPaymentIntent
SalesforceAdyenSavedPaymentMethod
SalesforceBancontactPaymentDetails
SalesforceCardPaymentDetails
SalesforceEpsPaymentDetails
SalesforceIdealPaymentDetails
SalesforceKlarnaPaymentDetails
SalesforcePaymentDetails
SalesforcePaymentIntent
SalesforcePaymentMethod
SalesforcePaymentRequest
SalesforcePaymentsHooks
SalesforcePaymentsMerchantAccount
SalesforcePaymentsMerchantAccountPaymentMethod
SalesforcePaymentsMgr
SalesforcePaymentsSiteConfiguration
SalesforcePaymentsZone
SalesforcePayPalOrder
SalesforcePayPalOrderAddress
SalesforcePayPalOrderPayer
SalesforcePayPalPaymentDetails
SalesforceSepaDebitPaymentDetails
SalesforceVenmoPaymentDetails
dw.extensions.pinterest
dw.io
dw.job
dw.net
dw.object
dw.order
dw.order.hooks
dw.rpc
dw.sitemap
dw.suggest
dw.svc
dw.system
dw.template
dw.util
dw.value
dw.web
dw.ws
B2C Commerce Developer Sandbox REST API

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!