Kundenreferenz

In dieser Referenz werden die JavaScript-Clientmethoden beschrieben, die Sie zum Implementieren der Google Pay API in Ihren Webanwendungen verwenden können.

Konstruktor

Initialisiert das PaymentsClient-Objekt. Sie müssen diesen Konstruktor aufrufen, bevor Sie Mitgliedsmethoden aufrufen.

new PaymentsClient(paymentOptions)

Argumente

Attribut Beschreibung
paymentOptions

Ein Objekt, das Schlüssel/Wert-Paare mit Konfigurationsdaten für die Google Pay API enthält. Informationen zu den verschiedenen konfigurierbaren Attributen finden Sie unter PaymentOptions.

Beispiel: {environment:'PRODUCTION'}

Retouren

Typ Beschreibung
google.payments.api.PaymentsClient Das PaymentsClient-Objekt.

Decken

Typ Beschreibung
Error

Der übergebene Wert der Umgebungseigenschaft wird nicht unterstützt.

Objektmethoden

createButton(options)

Mit der Convenience-Methode wird eine Google Pay-Zahlungsschaltfläche mit dem aktuellen Google Pay-Branding für die Einfügung auf einer Webseite generiert.

Die generierte HTMLElement enthält dynamisch eingefügtes CSS und ein SVG-Bild, das auf dem CDN von Google gehostet wird.

Weitere Informationen zur Auswahl der richtigen Schaltflächenfarbe und des richtigen Schaltflächentyps für das Design Ihrer Website finden Sie in unseren Markenrichtlinien. Möglicherweise müssen Sie die Abmessungen der Schaltfläche an ähnliche Schaltflächen oder Elemente auf Ihrer Seite anpassen. Mit unserem Tool Schaltfläche anpassen können Sie eine Schaltfläche für Ihren Anwendungsfall konfigurieren.

Argumente

Name Beschreibung
options

Ein Objekt, das Schlüssel/Wert-Paare für eine Schaltflächenkonfiguration enthält. Informationen zu konfigurierbaren Attributen finden Sie unter ButtonOptions.

Beispiel: {onClick:onGooglePaymentButtonClicked}

Retouren

Typ Beschreibung
HTMLElement Ein HTML-<button>-Element in einem allgemeinen Container für Flussinhalte wie <div>.

Decken

Typ Beschreibung
Error

Eine erforderliche Property ist nicht festgelegt.

isReadyToPay(isReadyToPayRequest)

Verwenden Sie die isReadyToPay(isReadyToPayRequest)-Methode, um zu ermitteln, ob ein Nutzer ein Zahlungsmittel aus der Google Pay API zurückgeben kann.

Wenn der Browser Google Pay unterstützt, gibt isReadyToPay den Wert true zurück. Wenn Sie feststellen möchten, ob der Nutzer in einem Google-Konto angemeldet ist oder bereits eine Zahlungsmethode in Google Pay gespeichert hat, legen Sie IsReadyToPayRequest.existingPaymentMethodRequired auf true fest und prüfen Sie, ob paymentMethodPresent im aufgelösten Promise true zurückgibt. Weitere Informationen finden Sie unter IsReadyToPayResponse.

Wenn PaymentsClient mit einer Umgebungsvariable von TEST initialisiert wird, gibt paymentMethodPresent immer true zurück.

Argumente

Name Beschreibung
isReadyToPayRequest Ein Objekt, das die vom Händler unterstützten Zahlungsmethoden enthält. Weitere Informationen zu den verschiedenen konfigurierbaren Attributen finden Sie unter IsReadyToPayRequest.

Retouren

Typ Beschreibung
Promise

Resolved:Ein Objekt mit Informationen zur Zahlungsfähigkeit des Nutzers. Weitere Informationen finden Sie unter IsReadyToPayResponse.

Abgelehnt:Ein Fehlerobjekt, das weitere Informationen zum Ablehnungsgrund enthält. Weitere Informationen finden Sie unter PaymentsError.

Fehler

statusCode Beschreibung
DEVELOPER_ERROR
  • Das übergebene IsReadyToPayRequest-Objekt war nicht richtig formatiert, enthielt nicht die erforderlichen Mindestparameter, um die Zahlungsbereitschaft eines Nutzers zu ermitteln, oder es enthielt einen ungültigen Parameter und/oder Wert.
  • Die Anfrage wurde aus einem Sicherheitskontext initiiert, der vom Zahlungsdienstleister oder Browser nicht erfüllt wurde. Häufig handelt es sich dabei um einen Fehler im unsicheren Browserkontext.

loadPaymentData(paymentDataRequest)

Bei dieser Methode wird ein Google Pay-Zahlungsformular angezeigt, in dem eine Zahlungsmethode und optional konfigurierte Parameter ausgewählt werden können.

Diese Methode muss aufgerufen werden, während der Browser ein Aktivierungsverhalten als Ergebnis eines Klickereignisses verarbeitet. Dem Nutzer wird möglicherweise ein Pop-up-Fenster angezeigt, in dem er eine Zahlungsmethode oder andere erforderliche Daten auswählen kann, die im übergebenen Anfrageparameter angegeben sind.

Argumente

Name Beschreibung
paymentDataRequest Ein Objekt, das Schlüssel/Wert-Paare der vollständigen Google Pay API-Konfiguration enthält. Informationen zu konfigurierbaren Attributen finden Sie unter PaymentDataRequest.

Retouren

Typ Beschreibung
Promise

Geklärt:Ein Objekt, das die angeforderten Käuferdaten enthält. Weitere Informationen finden Sie unter PaymentData.

Abgelehnt:Ein Objekt mit einem Fehlercode und weiteren Informationen zum Grund für die Ablehnung. Weitere Informationen finden Sie unter PaymentsError.

Fehler

statusCode Beschreibung
CANCELED
  • Der aktuelle Browser oder der angemeldete Google-Nutzer wird nicht unterstützt.
  • Der Käufer hat das Google Pay-Zahlungsblatt ohne Zahlungsautorisierung geschlossen.
  • Die Anfrage wurde aus einem Sicherheitskontext heraus initiiert, den der Zahlungsdienstleister oder der Browser nicht erfüllen wollte. Meistens ist das ein unsicherer Browserkontext.
  • Die Methode wurde aufgerufen, während das Google Pay-Zahlungsblatt bereits angezeigt wurde.
  • Das übergebene PaymentDataRequest-Objekt wurde vom Google Pay-Zahlungsblatt abgelehnt. Häufige Ursachen sind fehlende oder unvollständige PaymentMethodTokenizationSpecification-Parameter für Ihr Gateway oder ungültige Parameterwerte.
DEVELOPER_ERROR Das übergebene PaymentDataRequest-Objekt war falsch formatiert, es fehlten die erforderlichen Mindestparameter oder es enthielt einen ungültigen Parameter und/oder Wert.

prefetchPaymentData(paymentDataRequest)

Mit dieser Methode können Sie eine PaymentDataRequest-Konfiguration vorabrufen, um die loadPaymentData-Ausführungszeit bei späteren Nutzerinteraktionen zu verkürzen. Es wird kein Wert zurückgegeben.

Prefetch-Optimierungen sind in Chrome für Android verfügbar.

Argumente

Name Beschreibung
paymentDataRequest Ein Objekt, das Schlüssel/Wert-Paare der vollständigen Google Pay API-Konfiguration enthält. Informationen zu konfigurierbaren Attributen finden Sie unter PaymentDataRequest. Eine Änderung des Attributs transactionInfo hat keine Auswirkungen auf den im Cache gespeicherten Prefetch-Wert.

onPaymentAuthorized(paymentData)

Diese Methode wird aufgerufen, wenn eine Zahlung im Zahlungsformular autorisiert wird.

Argumente

Name Beschreibung
paymentData Ein Objekt mit den angeforderten Käuferdaten. Weitere Informationen finden Sie unter PaymentData.

Retouren

Typ Beschreibung
Promise

Resolved:Ein Objekt mit Informationen zu den Ergebnissen von Zahlungs- und Transaktionsvorgängen. Weitere Informationen finden Sie unter PaymentAuthorizationResult.

Abgelehnt:Ein Fehlerobjekt mit einer Fehlerabsicht und einer Meldung, die im Zahlungsformular gerendert werden soll. Weitere Informationen finden Sie unter PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

Mit dieser Methode werden Änderungen an Zahlungsdaten im Zahlungsblatt verarbeitet, z. B. an der Versandadresse und den Versandoptionen.

Argumente

Name Beschreibung
intermediatePaymentData Ein Objekt, das die ausgewählte Adresse und Versandoption im Zahlungsblatt enthält. Weitere Informationen finden Sie unter IntermediatePaymentData.

Retouren

Typ Beschreibung
Promise

Resolved:Ein Objekt, das Informationen zu neuen Transaktionsinformationen, Versandoptionen und Zahlungsdatenfehlern enthält. Weitere Informationen finden Sie unter PaymentDataRequestUpdate.

Abgelehnt:Ein Fehlerobjekt mit einer Fehlerabsicht und einer Nachricht, die im Zahlungsformular gerendert werden soll. Weitere Informationen finden Sie unter PaymentDataError.