Objets de réponse JSON

Cette référence décrit les options de l'objet de réponse de l'API Google Pay à utiliser avec votre application. Les objets de réponse sont des objets renvoyés par les méthodes client de l'API Google Pay.

PaymentData

Il s'agit d'un objet de réponse renvoyé par Google après qu'un payeur a approuvé un paiement.

PaymentDataRequest.PaymentDataRequest.PaymentDataRequest.
Propriété Type Existe toujours Description
apiVersion nombre Oui Version majeure de l'API. La valeur de la réponse correspond à celle fournie dans
apiVersionMinor nombre Oui Version mineure de l'API. La valeur de la réponse correspond à celle fournie dans
paymentMethodData PaymentMethodData Oui Données sur le mode de paiement sélectionné.
email chaîne Non Adresse e-mail, si emailRequired est défini sur true dans PaymentDataRequest. Si une autre requête a défini la propriété sur true, cela n'a aucun effet.
shippingAddress Adresse Non Adresse de livraison, si shippingAddressRequired est défini sur true dans

Exemple

Cet exemple de réponse pour la version 2.0 de l'API Google Pay montre un mode de paiement CARD sélectionné dans la feuille de paiement Google Pay. Un jeton de mode de paiement a été généré pour la passerelle example.

{
  "apiVersion": 2,
  "apiVersionMinor": 0,
  "paymentMethodData": {
    "type": "CARD",
    "description": "Visa •••• 1234",
    "info": {
      "cardNetwork": "VISA",
      "cardDetails": "1234",
      "cardFundingSource": "CREDIT"
    },
    "tokenizationData": {
      "type": "PAYMENT_GATEWAY",
      "token": "examplePaymentMethodToken"
    }
  }
}

PaymentMethodData

Cet objet fournit des données pour un mode de paiement sélectionné.

Propriété Type Existe toujours Description
type chaîne Oui PaymentMethod type sélectionné dans la feuille de paiement Google Pay.
description chaîne Oui

Message destiné à l'utilisateur pour décrire le mode de paiement qui finance cette transaction.
info objet Oui La valeur de cette propriété dépend du mode de paiement type renvoyé. Pour CARD, consultez CardInfo.
tokenizationData PaymentMethodTokenizationData Non Données de tokenisation du paiement pour le mode de paiement sélectionné.

Exemple

Cet exemple de réponse montre comment un mode de paiement CARD sélectionné dans la feuille de paiement Google Pay génère un jeton de mode de paiement pour la passerelle example.

{
  "type": "CARD",
  "description": "Visa •••• 1234",
  "info": {
    "cardNetwork": "VISA",
    "cardDetails": "1234"
  },
  "tokenizationData": {
    "type": "PAYMENT_GATEWAY",
    "token": "examplePaymentMethodToken"
  }
}

CardInfo

Cet objet fournit des informations sur la carte de paiement sélectionnée.

Propriété Type Existe toujours Description
cardDetails chaîne Oui Informations sur la carte. Cette valeur correspond généralement aux quatre derniers chiffres du numéro de compte de paiement sélectionné.
assuranceDetails AssuranceDetailsSpecifications Oui Cet objet fournit des informations sur la validation effectuée sur les données de paiement renvoyées si assuranceDetailsRequired est défini sur true dans CardParameters.
cardNetwork chaîne Oui

Réseau de la carte de paiement du paiement sélectionné. Les valeurs renvoyées correspondent au format de allowedCardNetworks dans CardParameters de CardParameters.

Cette valeur de réseau de carte ne doit pas être affichée à l'acheteur. Il est utilisé lorsque les informations de la carte d'un acheteur sont nécessaires. Par exemple, si le service client a besoin de cette valeur pour identifier la carte utilisée par un acheteur pour sa transaction. Pour une description visible par l'utilisateur, utilisez plutôt la propriété description de PaymentMethodData.
billingAddress Adresse Non Adresse de facturation associée au mode de paiement fourni, si billingAddressRequired est défini sur true dans CardParameters.
cardFundingSource chaîne Oui

Source de financement de la carte pour le mode de paiement sélectionné.

  • UNKNOWN
  • CREDIT
  • DEBIT
  • PREPAID

Exemple

Cet exemple montre une carte sur le réseau Visa.

{
  "cardNetwork": "VISA",
  "cardDetails": "1234",
  "cardFundingSource": "CREDIT",
  "assuranceDetails": {
    "cardHolderAuthenticated": false,
    "accountVerified": true
  }
}

AssuranceDetailsSpecifications

Cet objet fournit des informations sur la validation effectuée sur les identifiants de paiement renvoyés afin que les vérifications appropriées des risques liés aux instruments puissent être appliquées.

Nom Type Description
accountVerified booléen Si la valeur est true, cela indique que la validation de la possession Cardholder a été effectuée sur l'identifiant de paiement renvoyé.
cardHolderAuthenticated booléen

Si la valeur est true, cela indique que l'identification et la validation (ID&V) ont été effectuées sur le moyen de paiement renvoyé.

Si false, la même authentification basée sur le risque peut être effectuée que pour les transactions par carte. Cette authentification basée sur les risques peut inclure, sans s'y limiter, une authentification renforcée avec le protocole 3D Secure, le cas échéant.

Vous pouvez recevoir et traiter l'objet de réponse même si vous n'utilisez pas le champ assuranceDetails. Pour recevoir cet objet, incluez assuranceDetailsRequired: true dans l'objet Request CardParameters.

PaymentMethodTokenizationData

Cet objet fournit des données de tokenisation pour le mode de paiement.

Propriété Type Existe toujours Description
type chaîne Oui Type de tokenisation à appliquer au mode de paiement sélectionné. Cette valeur correspond à type défini dans PaymentMethodTokenizationSpecification.
token chaîne Non

Jeton de mode de paiement généré.

Exemple

Voici un exemple de réponse tokenisée préparée pour la passerelle example.

{
  "type": "PAYMENT_GATEWAY",
  "token": "examplePaymentMethodToken"
}

Adresse

Cet objet fournit des informations sur une adresse postale demandée. Toutes les propriétés sont des chaînes.

Les adresses peuvent être renvoyées aux formats MIN, FULL et FULL-ISO3166. Les propriétés appartenant à chaque format sont indiquées dans le tableau suivant.

Propriété Format de l'adresse Description
name MIN, FULL, FULL-ISO3166 Nom complet du destinataire.
postalCode MIN, FULL, FULL-ISO3166 Code postal.
countryCode MIN, FULL, FULL-ISO3166 Code pays ISO 3166-1 alpha-2.
phoneNumber MIN, FULL, FULL-ISO3166 Un numéro de téléphone, si phoneNumberRequired est défini sur true dans PaymentDataRequest.
address1 FULL et FULL-ISO3166 Première ligne de l'adresse.
address2 FULL et FULL-ISO3166 Seconde ligne de l'adresse.
address3 FULL et FULL-ISO3166 Troisième ligne de l'adresse.
locality FULL et FULL-ISO3166 Ville, quartier ou banlieue.
administrativeArea FULL et FULL-ISO3166 Subdivision d'un pays, comme un État ou une province.
sortingCode FULL et FULL-ISO3166 Code de tri.
iso3166AdministrativeArea FULL-ISO3166 Code de zone administrative ISO 3166-2 correspondant à administrativeArea.

Exemple

Voici un exemple d'adresse au format FULL-ISO3166 aux États-Unis avec plusieurs lignes de données d'adresse.

{
  "name": "John Doe",
  "address1": "c/o Google LLC",
  "address2": "1600 Amphitheatre Pkwy",
  "address3": "Building 40",
  "locality": "Mountain View",
  "administrativeArea": "CA",
  "countryCode": "US",
  "postalCode": "94043",
  "sortingCode": ""
  "iso3166AdministrativeArea": "US-CA"
}