Référence client

Cette référence décrit les méthodes du client JavaScript à utiliser pour implémenter l'API Google Pay dans vos applications Web.

Constructeur

Initialise l'objet PaymentsClient. Vous devez appeler ce constructeur avant d'appeler des méthodes membres.

new PaymentsClient(paymentOptions)

Arguments

Propriété Description
paymentOptions

Objet contenant des paires clé-valeur de données de configuration de l'API Google Pay configuration data. See PaymentOptions for the different properties configurable.

Exemple : {environment:'PRODUCTION'}

Renvoie

Type Description
google.payments.api.PaymentsClient Objet PaymentsClient.

Génère

Type Description
Error

La valeur de la propriété d'environnement transmise n'est pas acceptée.

Méthodes d'objet

createButton(options)

La méthode pratique permet de générer un bouton de paiement Google Pay stylisé avec la dernière image de marque Google Pay pour l'insérer dans une page Web.

Le HTMLElement généré inclut du code CSS inséré de manière dynamique et une image SVG hébergée sur le CDN de Google.

Pour en savoir plus sur la sélection de la couleur et du type de bouton appropriés pour la conception de votre site, consultez nos consignes concernant la marque. Vous devrez peut-être modifier les dimensions du bouton pour qu'il corresponde à des boutons ou des éléments de paiement semblables sur votre page. Utilisez notre Personnaliser votre bouton outil pour configurer un bouton adapté à votre cas d'utilisation.

Arguments

Nom Description
options

Objet contenant des paires clé-valeur pour une configuration de bouton. Consultez ButtonOptions pour connaître les propriétés configurables.

Exemple : {onClick:onGooglePaymentButtonClicked}

Renvoie

Type Description
HTMLElement Élément HTML <button> dans un conteneur de contenu de flux générique tel qu'un élément <div>.

Génère

Type Description
Error

Une propriété obligatoire n'est pas définie.

isReadyToPay(isReadyToPayRequest)

Utilisez la méthode isReadyToPay(isReadyToPayRequest) pour déterminer si un utilisateur peut renvoyer un mode de paiement à partir de l'API Google Pay.

Si le navigateur est compatible avec Google Pay, isReadyToPay renvoie true. Pour déterminer si l' utilisateur est connecté à un compte Google ou s'il a déjà enregistré un mode de paiement dans Google Pay, définissez IsReadyToPayRequest.existingPaymentMethodRequired sur true et vérifiez que paymentMethodPresent renvoie true dans la promesse résolue. Pour en savoir plus, consultez IsReadyToPayResponse.

Si PaymentsClient est initialisé avec une propriété d'environnement TEST, paymentMethodPresent renvoie toujours true.

Arguments

Nom Description
isReadyToPayRequest Objet contenant les modes de paiement acceptés par le marchand. Pour en savoir plus sur les différentes propriétés configurables, consultez IsReadyToPayRequest.

Renvoie

Type Description
Promise

Résolu : objet contenant des informations sur la capacité de l'utilisateur à payer. Pour en savoir plus, consultez IsReadyToPayResponse.

Refusé : objet d'erreur contenant plus d'informations sur le motif du refus. Pour en savoir plus, consultez PaymentsError.

Erreurs

statusCode Description
DEVELOPER_ERROR
  • L'objet transmis IsReadyToPayRequest n'était pas correctement formaté, ne contenait pas les paramètres minimaux requis pour déterminer si un utilisateur peut payer, ou contenait un paramètre et/ou une valeur non valides.
  • La requête a été lancée à partir d'un contexte de sécurité que l'agent de paiement ou le navigateur a choisi de ne pas exécuter. Il s'agit le plus souvent d'une erreur de contexte de navigateur non sécurisé.

loadPaymentData(paymentDataRequest)

Cette méthode présente une feuille de paiement Google Pay qui permet de sélectionner un mode de paiement et des paramètres éventuellement configurés.

Cette méthode doit être appelée pendant que le navigateur traite un comportement d'activation suite à un événement de clic. Une fenêtre pop-up peut s'afficher pour permettre à l'utilisateur de sélectionner un mode de paiement ou d'autres données requises spécifiées dans le paramètre de requête transmis.

Arguments

Nom Description
paymentDataRequest Objet contenant des paires clé-valeur de configuration complète de l'API Google Pay configuration. Consultez PaymentDataRequest pour connaître les propriétés configurables.

Renvoie

Type Description
Promise

Résolu : objet contenant les données de l'acheteur demandées. Pour en savoir plus, consultez PaymentData.

Refusé : objet contenant un code d'erreur et plus d'informations sur le motif du refus. Pour en savoir plus, consultez PaymentsError.

Erreurs

statusCode Description
CANCELED
  • Le navigateur actuel ou l'utilisateur Google connecté n'est pas compatible.
  • L'acheteur a fermé la feuille de paiement Google Pay sans autoriser le paiement.
  • La requête a été lancée à partir d'un contexte de sécurité que l'agent de paiement ou le navigateur a choisi de ne pas exécuter. Il s'agit le plus souvent d'un contexte de navigateur non sécurisé.
  • La méthode a été appelée alors que la feuille de paiement Google Pay était déjà affichée.
  • L'objet PaymentDataRequest transmis a été refusé par la feuille de paiement Google Pay. Les paramètres PaymentMethodTokenizationSpecification manquants ou incomplets pour votre passerelle, ou les valeurs de paramètres non valides sont une cause fréquente.
DEVELOPER_ERROR L'objet PaymentDataRequest transmis n'était pas correctement formaté, ne contenait pas les paramètres minimaux requis, ou contenait un paramètre et/ou une valeur non valides.

prefetchPaymentData(paymentDataRequest)

Utilisez cette méthode pour prérécupérer une configuration PaymentDataRequest afin d'améliorer loadPaymentData le temps d'exécution lors d'une interaction ultérieure de l'utilisateur. Aucune valeur n'est renvoyée.

Les optimisations de la prérécupération sont disponibles sur Chrome pour Android.

Arguments

Nom Description
paymentDataRequest Objet contenant des paires clé-valeur de configuration complète de l'API Google Pay configuration. Consultez PaymentDataRequest pour connaître les propriétés configurables. Une modification de la propriété transactionInfo n'affecte pas la valeur de prérécupération mise en cache.

Rappels de données de paiement

Les gestionnaires de rappel suivants peuvent être transmis à PaymentOptions.paymentDataCallbacks pour prendre en charge l'autorisation des paiements et les mises à jour dynamiques des prix.

onPaymentAuthorized(paymentData)

Cette méthode est appelée lorsqu'un paiement est autorisé dans la feuille de paiement.

Arguments

Nom Description
paymentData Objet contenant les données de l'acheteur demandées. Pour en savoir plus, consultez PaymentData.

Renvoie

Type Description
Promise

Résolu : objet contenant des informations sur les résultats de la transaction de paiement. Pour en savoir plus, consultez PaymentAuthorizationResult.

Refusé : objet d'erreur avec une intention et un message d'erreur à afficher dans la feuille de paiement. Pour en savoir plus, consultez PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

Cette méthode gère les modifications des données de paiement dans la feuille de paiement, telles que l'adresse de livraison et les options d'expédition.

Arguments

Nom Description
intermediatePaymentData Objet contenant l'adresse et l'option d'expédition sélectionnées dans la feuille de paiement. Pour en savoir plus, consultez IntermediatePaymentData.

Renvoie

Type Description
Promise

Résolu : objet contenant des informations sur les nouvelles informations de transaction, options d'expédition et erreurs de données de paiement. Pour en savoir plus, consultez PaymentDataRequestUpdate.

Refusé : objet d'erreur avec une intention et un message d'erreur à afficher dans la feuille de paiement. Pour en savoir plus, consultez PaymentDataError.