Class SalesforcePaymentsHooks
This interface represents all script hooks that can be registered to customize the Salesforce Payments functionality. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.
It contains the extension points (hook names), and the functions that are called by each extension point. A function must be defined inside a JavaScript source and must be exported. The script with the exported hook function must be located inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks inside the hooks property:
A hook entry has a 'name' and a 'script' property.
- The 'name' contains the extension point, the hook name.
- The 'script' contains the script relative to the hooks file, with the exported hook function.
| Constant | Description |
|---|---|
| extensionPointAdyenNotification: String = "dw.extensions.payments.adyenNotification" | The extension point name dw.extensions.payments.adyenNotification. |
| extensionPointAsyncPaymentSucceeded: String = "dw.extensions.payments.asyncPaymentSucceeded" | The extension point name dw.extensions.payments.asyncPaymentSucceeded. |
| extensionPointSendOrderConfirmationEmail: String = "dw.extensions.payments.sendOrderConfirmationEmail" | The extension point name dw.extensions.payments.sendOrderConfirmationEmail. |
| extensionPointStripePaymentEvent: String = "dw.extensions.payments.stripePaymentEvent" | The extension point name dw.extensions.payments.stripePaymentEvent. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| adyenNotification(Order) | Called when an Adyen webhook notification is received for the given order. |
| asyncPaymentSucceeded(Order) | Called when asynchronous payment succeeded for the given order. |
| sendOrderConfirmationEmail(Order) | Called to send order confirmation email after successful payment processing. |
| stripePaymentEvent(String, Order) | Called when a Stripe payment event is received for the given order. |
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
- extensionPointAdyenNotification: String = "dw.extensions.payments.adyenNotification"
The extension point name dw.extensions.payments.adyenNotification.
- extensionPointAsyncPaymentSucceeded: String = "dw.extensions.payments.asyncPaymentSucceeded"
The extension point name dw.extensions.payments.asyncPaymentSucceeded.
- extensionPointSendOrderConfirmationEmail: String = "dw.extensions.payments.sendOrderConfirmationEmail"
The extension point name dw.extensions.payments.sendOrderConfirmationEmail.
- extensionPointStripePaymentEvent: String = "dw.extensions.payments.stripePaymentEvent"
The extension point name dw.extensions.payments.stripePaymentEvent.
- adyenNotification(order: Order): Status
Called when an Adyen webhook notification is received for the given order.
Parameters:
- order - the order for which the notification was received
Returns:
- a non-null result ends the hook execution, and is ignored
- asyncPaymentSucceeded(order: Order): Status
Called when asynchronous payment succeeded for the given order.
Parameters:
- order - the order whose asynchronous payment succeeded
Returns:
- a non-null result ends the hook execution, and is ignored
- sendOrderConfirmationEmail(order: Order): Status
Called to send order confirmation email after successful payment processing.
Parameters:
- order - the order for which to send confirmation email
Returns:
- a non-null result ends the hook execution
- stripePaymentEvent(eventName: String, order: Order): Status
Called when a Stripe payment event is received for the given order.
Parameters:
- eventName - the Stripe event name, such as
"payment_intent.succeeded" - order - the order for which the event was received
Returns:
- a non-null result ends the hook execution, and is ignored
- eventName - the Stripe event name, such as