JSON レスポンス オブジェクト

このリファレンスでは、アプリケーションで使用する Google Pay API レスポンス オブジェクトのオプションについて説明します。レスポンス オブジェクトは、Google Pay API クライアント メソッドによって返されるオブジェクトです。

PaymentData

これは、支払人が支払いを承認した後に返されるレスポンス オブジェクトです。

PaymentDataRequest。PaymentDataRequest。PaymentDataRequest。
プロパティ 型 常に存在 説明
apiVersion 数値 可 メジャー API バージョン。レスポンスの値は
apiVersionMinor number 可 マイナー API バージョン。レスポンスの値は
paymentMethodData PaymentMethodData はい 選択したお支払い方法に関するデータ。
email 文字列 いいえ emailRequired が true に設定されている場合のメールアドレス PaymentDataRequest.これ以外のリクエストでこのプロパティが true に設定されていても、効果はありません。
shippingAddress Address いいえ shippingAddressRequired が true に設定されていた場合の配送先住所

例

この Google Pay API バージョン 2.0 のレスポンスの例は、Google Pay の支払いシートで CARD のお支払い方法が選択された場合を示しています。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

このオブジェクトは、選択したお支払い方法のデータを提供します。

プロパティ 型 常に存在 説明
type 文字列 はい Google Pay 支払いシートで選択された PaymentMethod type。
description 文字列 はい

この取引のお支払い方法を説明するユーザー向けメッセージ。
info オブジェクト はい このプロパティの値は、返されるお支払い方法の type によって異なります。CARD については、CardInfo をご覧ください。
tokenizationData PaymentMethodTokenizationData いいえ 選択したお支払い方法の支払いトークン化データ。

例

このレスポンスの例は、Google Pay 支払いシートで CARD のお支払い方法が選択され、example ゲートウェイの支払い方法トークンが生成された場合を示しています。

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

CardInfo

このオブジェクトは、選択した支払いカードに関する情報を提供します。

プロパティ 型 常に存在 説明
cardDetails 文字列 はい カードの詳細。通常、この値は選択したお支払いアカウント番号の最後の 4 桁です。
assuranceDetails AssuranceDetailsSpecifications はい CardParameters。
cardNetwork 文字列 はい

選択されたお支払い方法の支払いカード ネットワーク。戻り値は、allowedCardNetworks の形式に一致します CardParameters。

このカード ネットワークの値は購入者に表示しないでください。購入者のカードの詳細が必要な場合に使用します。たとえば、カスタマー サポートにおいて購入者が取引に使用したカードを識別しなければならない場合がこれに該当します。購入者に説明を表示する場合は、代わりに PaymentMethodData の description プロパティを使用してください。
billingAddress Address いいえ billingAddressRequired が true に設定されていた場合の、提供されたお支払い方法に関連付けられた請求先住所 CardParameters。
cardFundingSource 文字列 はい

選択したお支払い方法のカードの資金調達元。

  • UNKNOWN
  • CREDIT
  • DEBIT
  • PREPAID

例

この例は、Visa ネットワーク上のカードを示しています。

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

AssuranceDetailsSpecifications

このオブジェクトは、返された支払い認証情報で実行された検証に関する情報を提供します。これにより、適切なインストルメンテーションのリスクチェックを適用できます。

名前 型 説明
accountVerified ブール値 true の場合、返された支払い認証情報に対して Cardholder の所有検証が行われたことを示します。
cardHolderAuthenticated ブール値

true の場合、返された支払い認証情報で識別と検証（ID&V）が行われたことを示します。

false の場合、カード取引と同じリスクベースの認証を実行できます。このリスクベースの認証には、該当する場合は 3D セキュア プロトコルによるステップアップを含めることができますが、これに限定されません。

assuranceDetails フィールドを使用しない場合でも、レスポンス オブジェクトを受信して処理できます。このオブジェクトを受け取るには、リクエスト オブジェクトの CardParameters。

PaymentMethodTokenizationData

このオブジェクトは、お支払い方法のトークン化データを提供します。

プロパティ 型 常に存在 説明
type 文字列 はい 選択されたお支払い方法に適用されるトークン化のタイプ。この値は、 PaymentMethodTokenizationSpecification。
token 文字列 いいえ

生成された支払い方法トークン。

  • PAYMENT_GATEWAY: ゲートウェイによって発行された請求可能なトークンを含む JSON オブジェクト文字列。
  • DIRECT: 復号のための protocolVersion、signature、signedMessage。詳しくは、 支払い方法トークンの構造 をご覧ください。

例

これは、example ゲートウェイのトークン化データのレスポンスの例です。

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

住所

このオブジェクトは、リクエストされた住所に関する情報を提供します。すべてのプロパティは文字列です。

住所は MIN、FULL、FULL-ISO3166 の形式で返されます。各形式に属するプロパティは、次の表で確認できます。

プロパティ 住所の形式 説明
name MIN、FULL、FULL-ISO3166 受取人の氏名。
postalCode MIN、FULL、FULL-ISO3166 郵便番号。
countryCode MIN、FULL、FULL-ISO3166 ISO 3166-1 alpha-2 の国コード。
phoneNumber MIN、FULL、FULL-ISO3166 phoneNumberRequired が true に設定されていた場合の電話番号 PaymentDataRequest.
address1 FULL、FULL-ISO3166 住所の 1 行目
address2 FULL、FULL-ISO3166 住所の 2 行目。
address3 FULL、FULL-ISO3166 住所の 3 行目。
locality FULL、FULL-ISO3166 市、町、地区、または郊外。
administrativeArea FULL、FULL-ISO3166 地方行政区画（州や都道府県など）。
sortingCode FULL、FULL-ISO3166 ソートコード。
iso3166AdministrativeArea FULL-ISO3166 administrativeArea に対応する ISO 3166-2 行政区画コード。

例

これは、複数行の番地データを持つ米国の FULL-ISO3166 形式の住所の例です。

{
  "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"
}