Constructs a payment request using the given identifiers.

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.

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.

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.

SalesforcePaymentRequest.calculatePaymentRequestOptions(basket, {
    requestPayerName: true,
    requestPayerEmail: true,
    requestPayerPhone: false,
    requestShipping: true
});
 

returns

{
    currency: 'gbp',
    total: {
        label: 'Total',
        amount: '2644'
    },
    displayItems: [{
        label: 'Subtotal',
        amount: '1919'
    }, {
        label: 'Tax',
        amount: '126'
    }, {
        label: 'Ground',
        amount: '599'
    }],
    requestPayerName: true,
    requestPayerEmail: true,
    requestPayerPhone: false,
    requestShipping: true,
    shippingOptions: [{
        id: 'GBP001',
        label: 'Ground',
        detail: 'Order received within 7-10 business days',
        amount: '599'
    },{
        id: 'GBP002',
        label: 'Express',
        detail: 'Order received within 2-4 business days',
        amount: '999'
    }]
}
 

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.

SalesforcePaymentRequest.format({
    currency: 'GBP',
    total: {
        label: 'Total',
        amount: '26.44'
    },
    displayItems: [{
        label: 'Subtotal',
        amount: '19.19'
    }, {
        label: 'Tax',
        amount: '1.26'
    }, {
        label: 'Ground',
        amount: '5.99'
    }],
    requestPayerPhone: false,
    shippingOptions: [{
        id: 'GBP001',
        label: 'Ground',
        detail: 'Order received within 7-10 business days',
        amount: '5.99'
    }]
});
 

returns

{
    currency: 'gbp',
    total: {
        label: 'Total',
        amount: '2644'
    },
    displayItems: [{
        label: 'Subtotal',
        amount: '1919'
    }, {
        label: 'Tax',
        amount: '126'
    }, {
        label: 'Ground',
        amount: '599'
    }],
    requestPayerPhone: false,
    shippingOptions: [{
        id: 'GBP001',
        label: 'Ground',
        detail: 'Order received within 7-10 business days',
        amount: '599'
    }]
}
 

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

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 the identifier of this payment request.

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 the DOM element selector where to mount payment methods and/or express checkout buttons.

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.

request.setBasketData({
    sku: 'tv-pdp-6010fdM',
    quantity: 1,
    shippingMethod: '001',
    options: [{
        id: 'tvWarranty',
        valueId: '000'
    }]
});
 

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.

request.setOptions({
    currency: 'GBP',
    total: {
        label: 'Total',
        amount: '26.44'
    },
    displayItems: [{
        label: 'Subtotal',
        amount: '19.19'
    }, {
        label: 'Tax',
        amount: '1.26'
    }, {
        label: 'Ground',
        amount: '5.99'
    }],
    requestPayerPhone: false,
    shippingOptions: [{
        id: 'GBP001',
        label: 'Ground',
        detail: 'Order received within 7-10 business days',
        amount: '5.99'
    }]
});
 

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.

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.

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.

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.

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