Class SalesforcePaymentIntent

TopLevel.Object
- dw.extensions.payments.SalesforcePaymentIntent

Salesforce Payments representation of a Stripe 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.

Constant	Description
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.

Property	Description
ID: String `(read-only)`	Returns the identifier of this payment intent.
amount: Money `(read-only)`	Returns 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)`	Returns the client secret of this payment intent.
confirmed: Boolean `(read-only)`	Returns `true` if this payment intent has been confirmed, or `false` if not.
paymentMethod: SalesforcePaymentMethod `(read-only)`	Returns 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.

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

Method	Description
getAmount()	Returns the amount of this payment intent.
getClientSecret()	Returns the client secret of this payment intent.
getID()	Returns the identifier of this payment intent.
getPaymentInstrument(Basket)	Returns the payment instrument for this payment intent in the given basket, or `null` if the given basket has none.
getPaymentInstrument(Order)	Returns the payment instrument for this payment intent in the given order, or `null` if the given order has none.
getPaymentMethod()	Returns the payment method for this payment intent, or `null` if none has been established.
getSetupFutureUsage()	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()	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()	Returns `true` if this payment intent has been confirmed, or `false` if not.
isRefundable()	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.

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

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.

ID: String (read-only): Returns the identifier of this payment intent.

amount: Money (read-only): Returns 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): Returns the client secret of this payment intent.

confirmed: Boolean (read-only): Returns true if this payment intent has been confirmed, or false if not.

paymentMethod: SalesforcePaymentMethod (read-only): Returns 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.

See Also:

getAmount(): Money

Returns the amount of this payment intent.

Returns:

payment intent amount

getClientSecret(): String

Returns the client secret of this payment intent.

Returns:

payment intent client secret

getID(): String

Returns the identifier of this payment intent.

Returns:

payment intent identifier

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(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(): SalesforcePaymentMethod

Returns the payment method for this payment intent, or null if none has been established.

Returns:

payment method

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:

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(): Boolean

Returns true if this payment intent has been confirmed, or false if not.

Returns:

true if this payment intent has been confirmed

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