dw.extensions.payments
Class SalesforcePayPalOrder
dw.extensions.payments.SalesforcePayPalOrderSalesforce Payments representation of a PayPal order object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.
A PayPal order is automatically created when a shopper is ready to pay for items in their basket. It becomes completed when the shopper provides information to the payment provider that is acceptable to authorize payment for a given amount.
Constants
TYPE_PAYPAL
:
String = "paypal"
Represents the PayPal funding source.
TYPE_VENMO
:
String = "venmo"
Represents the Venmo funding source.
Properties
amount
:
Money
(Read Only)
The amount of this PayPal order.
captureID
:
String
(Read Only)
The ID of the capture against this order, or
null if not available.
completed
:
boolean
(Read Only)
Returns
true if this PayPal order has been completed, or false if not.
ID
:
String
(Read Only)
The identifier of this PayPal order.
payer
:
SalesforcePayPalOrderPayer
(Read Only)
The payer information for this PayPal order, or
null if not known.
shipping
:
SalesforcePayPalOrderAddress
(Read Only)
The shipping address for this PayPal order, or
null if not known.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getCaptureID()
:
String
Returns the ID of the capture against this order, or
null if not available.
getPayer()
:
SalesforcePayPalOrderPayer
Returns the payer information for this PayPal order, or
null if not known.
getPaymentDetails(paymentInstrument
:
OrderPaymentInstrument)
:
SalesforcePaymentDetails
Returns the details to the Salesforce Payments payment for this PayPal order, using the given payment instrument.
getPaymentInstrument(basket
:
Basket)
:
OrderPaymentInstrument
Returns the payment instrument for this PayPal order in the given basket, or
null if the given basket has none.
getPaymentInstrument(order
:
Order)
:
OrderPaymentInstrument
Returns the payment instrument for this PayPal order in the given order, or
null if the given order has none.
getShipping()
:
SalesforcePayPalOrderAddress
Returns the shipping address for this PayPal order, or
null if not known.
isCompleted()
:
boolean
Returns
true if this PayPal order has been completed, or false if not.
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
getCaptureID
getCaptureID()
:
String
Returns the ID of the capture against this order, or
null if not available.
Returns:
PayPal order capture identifier
getID
getID()
:
String
Returns the identifier of this PayPal order.
Returns:
PayPal order identifier
getPayer
getPayer()
:
SalesforcePayPalOrderPayer
Returns the payer information for this PayPal order, or
null if not known.
Returns:
order payer information
getPaymentDetails
Returns the details to the Salesforce Payments payment for this PayPal order, using the given payment instrument.
Parameters:
paymentInstrument
-
payment instrument
Returns:
The payment details
getPaymentInstrument
Returns the payment instrument for this PayPal order in the given basket, or
null if the given
basket has none.
Parameters:
basket
-
basket
Returns:
basket payment instrument
getPaymentInstrument
Returns the payment instrument for this PayPal order in the given order, or
null if the given
order has none.
Parameters:
order
-
order
Returns:
order payment instrument
getShipping
getShipping()
:
SalesforcePayPalOrderAddress
Returns the shipping address for this PayPal order, or
null if not known.
Returns:
order shipping address