PaymentResponse: payerdetailchange event
Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
payerdetailchange
events are delivered by the Payment Request API to a PaymentResponse
object when the user makes changes to their personal information while filling out a payment request form.
The event handler for payerdetailchange
should check each value in the form that has changed and ensure that the values are valid. If any are invalid, appropriate error messages should be configured and the retry()
method should be called on the PaymentResponse
to ask the user to update the invalid entries.
Bubbles | No |
---|---|
Cancelable | No |
Interface | PaymentRequestUpdateEvent |
Event handler property | onpayerdetailchange |
Examples
In the example below, onpayerdetailchange
is used to set up a listener for the payerdetailchange
event in order to validate the information entered by the user, requesting that any mistakes be corrected
// Options for PaymentRequest(), indicating that shipping address,
// payer email address, name, and phone number all be collected.
const options = {
requestShipping: true,
requestPayerEmail: true,
requestPayerName: true,
requestPayerPhone: true,
};
const request = new PaymentRequest(methods, details, options);
const response = request.show();
// Get the data from the response
let {
payerName: oldPayerName,
payerEmail: oldPayerEmail,
payerPhone: oldPayerPhone,
} = response;
// Set up a handler for payerdetailchange events, to
// request corrections as needed.
response.onpayerdetailchange = async ev => {
const promisesToValidate = [];
const { payerName, payerEmail, payerPhone } = response;
// Validate each value which changed by calling a function
// that validates each type of data, returning a promise which
// resolves if the data is valid.
if (oldPayerName !== payerName) {
promisesToValidate.push(validateName(payerName));
oldPayerName = payerName;
}
if (oldPayerEmail !== payerEmail) {
promisesToValidate.push(validateEmail(payerEmail));
oldPayerEmail = payerEmail;
}
if (oldPayerPhone !== payerPhone) {
promisesToValidate.push(validatePhone(payerPhone));
oldPayerPhone = payerPhone;
}
// As each validation promise resolves, add the results of the
// validation to the errors list
const errors = await Promise.all(promisesToValidate).then(results =>
results.reduce((errors, result), Object.assign(errors, result))
);
// If we found any errors, wait for them to be corrected
if (Object.getOwnPropertyNames(errors).length) {
await response.retry(errors);
} else {
// We have a good payment; send the data to the server
await fetch("/pay-for-things/", { method: "POST", body: response.json() });
response.complete("success");
}
};
await response.retry({
payer: {
email: "invalid domain.",
phone: "invalid number.",
},
});
addEventListener equivalent
You could also set up the event handler using the addEventListener()
method:
response.addEventListener("payerdetailchange", async ev => {
...
}
Specifications
Specification | Status | Comment |
---|---|---|
Payment Request API The definition of 'payerdetailchange event' in that specification. |
Candidate Recommendation |
Browser compatibility
BCD tables only load in the browser