顧客の氏名を収集

ビジネス名と個人名を決済時にファーストクラスのフィールドとして徴収します。

支払いフォームで名前回収を有効にして、顧客からビジネス名または個人名を徴収することができます。この情報は、セッションの完了後に利用可能になります。

これらのファーストクラスの名前は、Billing および配送先情報内で収集された名前とは別に、有効化されている場合は常に支払いフォームのトップレベルの名前フィールドとして表示されます。

決済では、連絡先の詳細内の支払いフォームに最上位の名前フィールドが追加されます。

名前回収の有効化

名前回収の設定を指定して、決済セッションを作成します。名前回収を有効にするには、決済セッションの作成時に name_回収オブジェクトを設定します。ビジネス名、個人名、またはその両方を徴収し、ニーズに応じて各フィールドを必須またはオプションとして設定できます。

注

ビジネス名回収を必須に設定すると、Express Checkout や Apple Pay などのワンクリックボタンが支払いフォームの下部に移動するか、無効になります。

収集した名前を取得する

セッション後の Customer オブジェクト、または決済セッションオブジェクトから顧客のビジネス名または個人名を取得できます。

顧客

決済では、収集された名前が Customer オブジェクトのそれぞれのビジネス名または個人名プロパティに保存されます。このプロパティには、API で Customer オブジェクトを直接取得するか、Webhook で customer.created イベントをリッスンすることでプログラムでアクセスできます。

Customer オブジェクトの名前も、その注文でビジネス名または個人名に設定されます。

{
  "object": {
    "id": "cus_HQmikpKnGHkNwW",
    "object": "customer",
    ...
    "name": "Stripe, Inc."
    "business_name": "Stripe, Inc."
    ...
    "individual_name": "Jenny Rosen"
    ...
  }
}

ダッシュボードで顧客名を確認することもできます。

決済セッション

顧客の名前は、決済 Sessionオブジェクトのcollected_informationハッシュと顧客_detailsハッシュにも保存されます。

{
  "object": {
    "id": "cs_test_a1dJwt0TCJTBsDkbK7RcoyJ91vJxe2Y",
    "object": "checkout.session",
    ...
    "collected_information": {
      "business_name": "Stripe, Inc.",
      "individual_name": "Jenny Rosen"
    },
    ...
    "customer": "cus_id_of_new_customer",
    "customer_details": {
      ...
      "business_name": "Stripe, Inc.",
      "individual_name": "Jenny Rosen",
      "name": "Stripe, Inc."
    },
    ...
  }
}

決済セッションが成功すると、Stripe は payment.session.completed イベントを送信します。このイベントには決済 Session オブジェクトと収集された値が含まれ、Webhook でリッスンできます。