Référence client

Cette documentation de 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 les 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. Consultez PaymentOptions pour connaître les différentes propriétés configurables.

Exemple : {environment:'PRODUCTION'}

Renvoie

Type Description
google.payments.api.PaymentsClient L'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 de commodité 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.

Consultez nos consignes relatives à la marque pour savoir comment sélectionner la couleur et le type de bouton adaptés à la conception de votre site. Vous devrez peut-être modifier les dimensions du bouton pour qu'elles correspondent à celles des boutons ou des éléments de paiement similaires de votre page. Utilisez notre outil Personnaliser votre bouton pour configurer un bouton adapté à votre cas d'utilisation.

Arguments

Nom Description
options

Objet contenant des paires clé/valeur pour la configuration d'un bouton. Consultez ButtonOptions pour connaître les propriétés configurables.

Exemple : {onClick:onGooglePaymentButtonClicked}

Renvoie

Type Description
HTMLElement Un é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 de 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 paiement de l'utilisateur. Pour en savoir plus, consultez IsReadyToPayResponse.

Rejected : 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 IsReadyToPayRequest transmis n'était pas correctement formaté, ne contenait pas les paramètres minimaux requis pour déterminer si l'utilisateur était prêt à payer, ou contenait un paramètre et/ou une valeur non valides.
  • La requête a été initiée à partir d'un contexte de sécurité que l'agent de paiement ou le navigateur a choisi de ne pas traiter. Le plus souvent, il s'agit 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 configurés de manière facultative.

Cette méthode doit être appelée pendant que le navigateur traite un comportement d'activation à la suite d'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 la configuration complète de l'API Google Pay. Consultez PaymentDataRequest pour connaître les propriétés configurables.

Renvoie

Type Description
Promise

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

Refusé : objet contenant un code d'erreur et des informations supplémentaires 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.
  • Le client a fermé la feuille de paiement Google Pay sans autorisation de 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 traiter. Le plus souvent, il s'agit 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ètre non valides sont une cause courante.
DEVELOPER_ERROR L'objet PaymentDataRequest transmis n'est pas correctement formaté, ne contient pas les paramètres minimaux requis ou contient un paramètre et/ou une valeur non valides.

prefetchPaymentData(paymentDataRequest)

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

Les optimisations de préchargement sont disponibles dans Chrome pour Android.

Arguments

Nom Description
paymentDataRequest Objet contenant des paires clé/valeur de la configuration complète de l'API Google Pay. Consultez PaymentDataRequest pour connaître les propriétés configurables. Une modification de la propriété transactionInfo n'affecte pas la valeur de préchargement 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

Resolved : objet contenant des informations sur les résultats des transactions de paiement. Pour en savoir plus, consultez PaymentAuthorizationResult.

Rejeté : un objet d'erreur avec un intent d'erreur et un message à 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 de livraison.

Arguments

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

Renvoie

Type Description
Promise

Resolved : objet contenant des informations sur les nouvelles informations de transaction, les options de livraison et les erreurs de données de paiement. Pour en savoir plus, consultez PaymentDataRequestUpdate.

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