dw.extensions.applepay
Class ApplePayHookResult
Object
dw.extensions.applepay.ApplePayHookResult

Result of a hook handling an Apple Pay request.

Use the constants in this type to indicate specific error reasons to be provided to Apple Pay JS. For example, the following code creates a Status that indicates the shipping contact information provided by Apple Pay is invalid:

 var ApplePayHookResult = require('dw/extensions/applepay/ApplePayHookResult');
 var Status = require('dw/system/Status');

 var error = new Status(Status.ERROR);
 error.addDetail(ApplePayHookResult.STATUS_REASON_DETAIL_KEY, ApplePayHookResult.REASON_SHIPPING_CONTACT);
 

If a specific error reason is not provided, the generic Apple Pay STATUS_FAILURE reason will be used when necessary.

Constants
REASON_BILLING_ADDRESS  :  String = "InvalidBillingPostalAddress"
Error reason code representing an invalid billing address.
REASON_FAILURE  :  String = "Failure"
Error reason code representing an error or failure not otherwise specified.
REASON_PIN_INCORRECT  :  String = "PINIncorrect"
Error reason code representing the PIN is incorrect.
REASON_PIN_LOCKOUT  :  String = "PINLockout"
Error reason code representing a PIN lockout.
REASON_PIN_REQUIRED  :  String = "PINRequired"
Error reason code representing a PIN is required.
REASON_SHIPPING_ADDRESS  :  String = "InvalidShippingPostalAddress"
Error reason code representing an invalid shipping address.
REASON_SHIPPING_CONTACT  :  String = "InvalidShippingContact"
Error reason code representing invalid shipping contact information.
STATUS_REASON_DETAIL_KEY  :  String = "reason"
Key for the detail to be used in Status objects to indicate the reason to communicate to Apple Pay for errors.
Properties
eventDetail  :  Object  (Read Only)
Detail to the JS custom event to dispatch in response to this result.
eventName  :  String  (Read Only)
Name of the JS custom event to dispatch in response to this result.
redirect  :  URL  (Read Only)
URL to navigate to in response to this result.
status  :  Status  (Read Only)
Status describing the outcome of this result.
Constructor Summary
ApplePayHookResult(status : Status, redirect : URL)
Constructs a result with the given outcome information.
Method Summary
getEventDetail() : Object
Detail to the JS custom event to dispatch in response to this result.
getEventName() : String
Name of the JS custom event to dispatch in response to this result.
getRedirect() : URL
URL to navigate to in response to this result.
getStatus() : Status
Status describing the outcome of this result.
setEvent(name : String) : void
Sets the name of the JS custom event to dispatch in response to this result.
setEvent(name : String, detail : Object) : void
Sets the name and detail of the JS custom event to dispatch in response to this result.
Salesforce Commerce Cloud Courses
Salesforce B2C Commerce Developer - Certification Tests
Why risk failing the SFCC exam? Get 180 real questions, killer content, and everything you need to crush the Salesforce B2C Commerce Developer certification.

Becoming a Salesforce B2C Commerce Developer is your ticket to higher salaries, better job opportunities, and the credibility to stand out from the competition. But let's be honestβ€”passing the certification exam isn't easy. That's where we come in.
Salesforce Javascript Developer I - Certification Tests
Not just another prep courseβ€”this is your shortcut to passing. Master JavaScript for Salesforce and go from 'hoping to pass' to knowing you will. Ready to start?

This isn't just another prep courseβ€”it's your shortcut to mastering the skills and confidence you need to pass. With multiple practice tests covering every section and a final exam simulation designed to mirror the real thing, you'll feel like you've already aced it before test day.
Salesforce B2C Commerce Architect - Certification Tests
Think the Developer exam was hard? Welcome to the next level.

The Salesforce B2C Commerce Architect certification is a whole different gameβ€”complex solutions, elevated difficulty, and skills that set you apart in the eCommerce industry. That's why we're including 11 downloadable PDF guides, packed with best practices and strategies to help you prepare for the exam and build confidence in every topic.
Constructor Detail
ApplePayHookResult
public ApplePayHookResult(status : Status, redirect : URL)
Constructs a result with the given outcome information.
Parameters:
status - status of the result
redirect - optional URL to which to navigate to in response to this outcome

Method Detail
getEventDetail
getEventDetail() : Object
Detail to the JS custom event to dispatch in response to this result.
Returns:
event detail

getEventName
getEventName() : String
Name of the JS custom event to dispatch in response to this result.
Returns:
event name

getRedirect
getRedirect() : URL
URL to navigate to in response to this result.
Returns:
redirect URL

getStatus
getStatus() : Status
Status describing the outcome of this result.
Returns:
status of this result

setEvent
setEvent(name : String) : void
Sets the name of the JS custom event to dispatch in response to this result.
Parameters:
name - JS custom event name

setEvent
setEvent(name : String, detail : Object) : void
Sets the name and detail of the JS custom event to dispatch in response to this result.
Parameters:
name - JS custom event name
detail - JS custom event detail

β™₯
Notifications pending to read