Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.extensions.payments
dw.extensions.payments
Class SalesforcePaymentIntent
Object
dw.extensions.payments.SalesforcePaymentIntent

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

A payment intent is automatically created when a shopper is ready to pay for items in their basket. It becomes confirmed when the shopper provides information to the payment provider that is acceptable to authorize payment for a given amount. Once that information has been provided it becomes available as the payment method associated with the payment intent.

Constants
SETUP_FUTURE_USAGE_OFF_SESSION  :  String = "off_session"
Represents the payment method setup future usage is off session.
SETUP_FUTURE_USAGE_ON_SESSION  :  String = "on_session"
Represents the payment method setup future usage is on session.
Properties
amount  :  Money  (Read Only)
The amount of this payment intent.
cancelable  :  boolean  (Read Only)
Returns true if this payment intent has a status which indicates it can be canceled, or false if its status does not indicate it can be canceled.
clientSecret  :  String  (Read Only)
The client secret of this payment intent.
confirmed  :  boolean  (Read Only)
Returns true if this payment intent has been confirmed, or false if not.
ID  :  String  (Read Only)
The identifier of this payment intent.
paymentMethod  :  SalesforcePaymentMethod  (Read Only)
The payment method for this payment intent, or null if none has been established.
refundable  :  boolean  (Read Only)
Returns true if this payment intent has a status and other state which indicate it can be refunded, or false if it cannot be refunded.
setupFutureUsage  :  String  (Read Only)
Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment intent can be used in the future or returns null if future usage is not set up.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAmount() : Money
Returns the amount of this payment intent.
getClientSecret() : String
Returns the client secret of this payment intent.
getID() : String
Returns the identifier of this payment intent.
getPaymentInstrument(basket : Basket) : OrderPaymentInstrument
Returns the payment instrument for this payment intent in the given basket, or null if the given basket has none.
getPaymentInstrument(order : Order) : OrderPaymentInstrument
Returns the payment instrument for this payment intent in the given order, or null if the given order has none.
getPaymentMethod() : SalesforcePaymentMethod
Returns the payment method for this payment intent, or null if none has been established.
getSetupFutureUsage() : String
Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment intent can be used in the future or returns null if future usage is not set up.
isCancelable() : boolean
Returns true if this payment intent has a status which indicates it can be canceled, or false if its status does not indicate it can be canceled.
isConfirmed() : boolean
Returns true if this payment intent has been confirmed, or false if not.
isRefundable() : boolean
Returns true if this payment intent has a status and other state which indicate it can be refunded, or false if it cannot be refunded.
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
getAmount
getAmount() : Money
Returns the amount of this payment intent.
Returns:
payment intent amount
getClientSecret
getClientSecret() : String
Returns the client secret of this payment intent.
Returns:
payment intent client secret
getID
getID() : String
Returns the identifier of this payment intent.
Returns:
payment intent identifier
getPaymentInstrument
getPaymentInstrument(basket : Basket) : OrderPaymentInstrument
Returns the payment instrument for this payment intent in the given basket, or null if the given basket has none.
Parameters:
basket - basket
Returns:
basket payment instrument
getPaymentInstrument
getPaymentInstrument(order : Order) : OrderPaymentInstrument
Returns the payment instrument for this payment intent in the given order, or null if the given order has none.
Parameters:
order - order
Returns:
order payment instrument
getPaymentMethod
getPaymentMethod() : SalesforcePaymentMethod
Returns the payment method for this payment intent, or null if none has been established.
Returns:
payment method
getSetupFutureUsage
getSetupFutureUsage() : String
Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment intent can be used in the future or returns null if future usage is not set up.
Returns:
setup future usage or null if future usage is not set up
See Also:
SalesforcePaymentRequest.setSetupFutureUsage(Boolean)
SETUP_FUTURE_USAGE_OFF_SESSION
SETUP_FUTURE_USAGE_ON_SESSION
isCancelable
isCancelable() : boolean
Returns true if this payment intent has a status which indicates it can be canceled, or false if its status does not indicate it can be canceled.
Returns:
true if this payment intent has a status which indicates it can be canceled
isConfirmed
isConfirmed() : boolean
Returns true if this payment intent has been confirmed, or false if not.
Returns:
true if this payment intent has been confirmed
isRefundable
isRefundable() : boolean
Returns true if this payment intent has a status and other state which indicate it can be refunded, or false if it cannot be refunded.
Returns:
true if this payment intent has a status and other state which indicate it can be refunded

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.