PaymentResponse: retry() Methode
Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.
Die retry()
Methode des PaymentResponse
Interfaces ermöglicht es, den Benutzer aufzufordern, eine Zahlung nach einem Fehler während der Bearbeitung erneut zu versuchen.
Dies ermöglicht es Ihrer App, Situationen wie ungültige Lieferadressen oder abgelehnte Kreditkarten elegant zu behandeln.
Syntax
retry(errorFields)
Parameter
errorFields
-
Ein Objekt mit folgenden Eigenschaften:
error
Optional-
Eine allgemeine Beschreibung eines Zahlungsfehlers, von dem sich der Benutzer möglicherweise erholen kann, indem er die Zahlung erneut versucht, möglicherweise nachdem Fehler in den Zahlungsinformationen korrigiert wurden.
error
kann alleine bereitgestellt werden, um nur eine generische Fehlermeldung bereitzustellen, oder in Verbindung mit den anderen Eigenschaften, um als Übersicht zu dienen, während die Werte anderer Eigenschaften den Benutzer zu Fehlern in bestimmten Feldern des Zahlungsformulars führen. - `paymentMethod Optional
-
Alle spezifischen Fehler, die bei der Zahlungsmethode aufgetreten sein könnten. Der Inhalt dieses Objekts variiert je nach verwendeter Zahlungsmethode.
Rückgabewert
Ein Promise
, das aufgelöst wird, wenn die Zahlung erfolgreich abgeschlossen ist. Das Promise wird mit einem entsprechenden Ausnahme-Wert abgelehnt, wenn die Zahlung erneut fehlschlägt.
Normalerweise verwenden Sie dies, indem Sie show()
aufrufen und dann eine Schleife oder rekursive Funktion betreten, die die PaymentResponse
auf Fehler oder andere Gründe überprüft, um die Zahlungsanforderung erneut zu versuchen. Wenn ein erneuter Versuch erforderlich ist, ruft die Schleife retry()
auf und kehrt dann zur Überprüfung der Antwort zurück, wenn sie eingeht. Die Schleife wird nur beendet, wenn der Benutzer entweder die Zahlungsanfrage storniert oder die Anfrage erfolgreich ist.
Siehe das Beispiel unten für ein ausführliches Beispiel, aber das Grundkonzept in Umrissform ist:
-
Erstellen Sie eine neue
PaymentRequest
(new
PaymentRequest()
) -
Zeigen Sie die Zahlungsanfrage an (
PaymentRequest.show()
-
Wenn
show()
aufgelöst wird, beschreibt die zurückgegebenePaymentResponse
die angeforderte Zahlung und die vom Benutzer gewählten Optionen. Fahren Sie mit den folgenden Schritten fort:- Überprüfen Sie die zurückgegebene Antwort; wenn es Felder gibt, deren Werte nicht akzeptabel sind, rufen Sie die
complete()
Methode der Antwort mit einem Wert von"fail"
auf, um ein Scheitern anzuzeigen. -
Wenn die Daten der Antwort gültig und akzeptabel sind, rufen Sie
complete("success")
auf, um die Zahlung abzuschließen und zu verarbeiten.
- Überprüfen Sie die zurückgegebene Antwort; wenn es Felder gibt, deren Werte nicht akzeptabel sind, rufen Sie die
-
Wenn
show()
abgelehnt wird, ist die Zahlungsanforderung fehlgeschlagen, normalerweise weil entweder bereits eine bearbeitet wird, weil der User Agent keine der angegebenen Zahlungsmethoden unterstützt oder wegen eines Sicherheitsproblems. Siehe die Liste der Ausnahmen fürshow()
für weitere Details. Rufen Siecomplete("fail")
auf, um die Zahlungsanforderung zu schließen.
async function handlePayment() {
const payRequest = new PaymentRequest(methodData, details, options);
try {
let payResponse = await payRequest.show();
while (validate(payResponse)) {
/* let the user edit the payment information,
wait until they submit */
await response.retry();
}
await payResponse.complete("success");
} catch (err) {
/* handle the exception */
}
}
Beispiele
async function doPaymentRequest() {
const request = new PaymentRequest(methodData, details, options);
const response = await request.show();
await recursiveValidate(request, response);
await response.complete("success");
}
// Keep validating until the data looks good!
async function recursiveValidate(request, response) {
const promisesToFixThings = [];
const errors = await validate(request, response);
if (!errors) {
return;
}
if (errors.shippingAddress) {
// "shippingaddresschange" fired at request object
const promise = fixField(
request,
"shippingaddresschange",
shippingValidator,
);
promisesToFixThings.push(promise);
}
if (errors.payer) {
// "payerdetailchange" fired at response object
const promise = fixField(response, "payerdetailchange", payerValidator);
promisesToFixThings.push(promise);
}
await Promise.all([response.retry(errors), ...promisesToFixThings]);
await recursiveValidate(request, response);
}
function fixField(requestOrResponse, event, validator) {
return new Promise((resolve) => {
// Browser keeps calling this until promise resolves.
requestOrResponse.addEventListener(event, async function listener(ev) {
const promiseToValidate = validator(requestOrResponse);
ev.updateWith(promiseToValidate);
const errors = await promiseToValidate;
if (!errors) {
// yay! fixed!
event.removeEventListener(event, listener);
resolve();
}
});
});
}
doPaymentRequest();
Spezifikationen
Specification |
---|
Payment Request API # dom-paymentresponse-retry |
Browser-Kompatibilität
BCD tables only load in the browser
Siehe auch
PaymentResponse
Interface.