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.

"hooks": "./hooks.json"

The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks inside the hooks property:

"hooks": [ {"name": "dw.extensions.payments.asyncPaymentSucceeded", "script": "./payments.js"} ]

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.

Constants

extensionPointAsyncPaymentSucceeded : String = "dw.extensions.payments.asyncPaymentSucceeded"

The extension point name dw.extensions.payments.asyncPaymentSucceeded.

Properties

Constructor Summary

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

Method Summary

asyncPaymentSucceeded(order : Order) : Status

Called when asynchronous payment succeeded for the given order.

Method Detail

asyncPaymentSucceeded

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