ユースケースをテストする

Stripe のテスト環境、テストモード、サンドボックスを使用すると、実際の請求や決済を行わずに導入をテストできます。これらの環境では、実際の取引に影響を与えたり、実際の資金を移動したりすることなく、実際のオブジェクトの作成をシミュレーションできます。テストプロセスに役立つように、品質保証 (QA) テストのユースケースを使用し、Postman コレクションをインポートすることをお勧めします。

テスト環境

テスト環境では、テスト用のクレジットカードに請求し、テスト用の商品と価格を作成できます。これらの環境では、取引をシミュレーションして、導入が正しく機能することを確認できます。この機能は、本番環境へ移行する前に、Stripe 導入のバグやエラーを特定するのに役立ちます。テストモードとサンドボックスのどちらを使用するかを判断する方法についてご確認ください。

Stripe アカウントを作成すると、Stripe ダッシュボードに一連のテスト API キーが表示されます。これらの API キーを使用して、Stripe API に対するリクエストを行うことで、シミュレーションデータを作成して取得できます。実際の決済の受け付けを開始するには、アカウントを有効化し、アカウント選択機能を使用してテスト環境を終了し、導入で本番 API キーを使用する必要があります。Stripe は、導入をテストするためのリソースを多数提供しています。

テスト環境の比較

テスト環境とサンドボックスは、実際の取引に影響を与えたり、実際の資金を移動したりすることなく、実際のオブジェクトの作成をシミュレーションするテスト環境です。それぞれを使用するタイミングを理解することで、テスト戦略の構築に役立ちます。

サンドボックスは、追加機能とテスト環境よりも優れた柔軟性を備えているため、テストのニーズに合わせて使用することをお勧めします。サンドボックスに移行すると、複数の環境、詳細なアクセス制御、分離された設定を使用してテスト機能を強化し、より堅牢で包括的なテスト戦略を構築できます。

テスト環境とサンドボックスの機能の違い

以下の表を参照して、違いを理解し、ニーズに最適な環境を選択してください。

テスト環境からサンドボックスへの移行

ダッシュボードでテスト環境からサンドボックスに移行するには、以下のようにします。

1. サンドボックスを作成し、そのサンドボックスへのアクセスを必要とするユーザーを招待します。
   • サンドボックスユーザー役割をチームメンバーに付与すると、本番ビジネスアカウントに関連付けられたサンドボックスを作成し、作成したサンドボックスを削除するためのアクセス権がチームメンバーに付与されます。テスト環境では、すべてのユーザーに自動的にアクセスできましたが、サンドボックスユーザー役割、管理者役割、開発者役割、サンドボックス管理者役割が付与されたユーザーのみがサンドボックスにアクセスできます。
2. サンドボックスの新しいテスト API キーとアカウント ID を取得します。
3. テスト製品、顧客、サブスクリプション、決済手段など、関連するテストデータを設定します。
   • (オプション) テストクロックを設定します。これは、Billing の導入をテストして、想定どおりに動作することを確認するのに役立ちます。テストクロックを使用すると、サンドボックスで時間の進行をシミュレーションし、サブスクリプションなどの Billing リソースの状態が変化し、Webhook イベントがトリガーされます。これにより、四半期ごとまたは年次の更新の決済失敗などのシナリオを、長期間待つことなく導入がどのように処理するかを確認できます。
4. テストプロセスのうち、特定のテストオブジェクト ID に依存する部分を更新します。これは、サンドボックスで新しいオブジェクトを作成するときに変更されます。

テスト環境と本番環境

Stripe API リクエストはすべて、テスト環境か、 本番環境 のいずれかで発生します。一方の環境の API オブジェクトには、もう一方の環境からアクセスできません。たとえば、テスト環境のProduct (商品) オブジェクトを本番環境の決済の一部にすることはできません。

ダッシュボードのテスト環境が、導入のコードに影響を与えることはありません。コードの動作に影響を与えるのは、テスト環境と本番環境の API キーです。

テストカード番号

Stripe は、さまざまな決済シナリオのシミュレーションに使用できる一連のテストカード番号を提供しています。これらのテストカード番号を使用すると、実際の決済や請求を処理することなく、シミュレーション用の決済をテスト環境で作成できます。

テストカード番号を使用すると、任意の将来の有効期限と 3 桁のセキュリティコードを入力して、決済の成功をシミュレーションできます。決済の失敗をシミュレーションする場合は、Stripe が提供する特定のテストカード番号とセキュリティコードを使用できます。

テストカード番号はテスト環境でのみ有効です。実際の決済には使用しないでください。

テストデータを削除する

すべてのテストデータを Stripe アカウントから削除するには、次の手順を実行してください。

1. 既存の Stripe アカウントを使用してダッシュボードにログインします。
2. テスト環境で、開発者 > 概要をクリックします。
3. テストデータセクションで、テストデータをレビューをクリックします。このダイアログに、既存のすべてのテストデータオブジェクトのリストが表示されます。
4. テストデータを削除をクリックして、削除プロセスを開始します。テストデータの削除を取り消すことはできません。

削除プロセスの実行中は、テスト環境が一時的に使用できなくなります。

テストメール

デフォルトでは、Stripe はテスト環境で顧客にメールを送信しません。たとえば、サンドボックスで請求書への決済を行うと、顧客に領収書のメールは送信されません。また、テスト環境で API を使用して確定された請求書についても、顧客に領収書メールは送信されません。

テスト環境で Stripe から顧客にメールを送信したい場合は、ダッシュボードで以下を実行できます。

• 請求書を作成して特定の顧客に手動で送信します。
• 決済済みの請求書の領収書を手動で送信します。

メールで請求書や領収書を確認する場合は、顧客オブジェクトにチームのメールアドレスを設定するか、PaymentIntent に receipt_email 属性を設定してください。

ユースケースをテストする

次の表には、品質保証 (QA) テストのユースケースが含まれています。

{
  ...
  "capture_method": "manual",
  ...
  "status": "requires_capture",
  ...
}

{
    ...
    "status": "succeeded",
    ...
  }

{
  "error": {
    "charge": "ch_ItrB4vtoksm4oc7q",
    "code": "card_declined",
    "decline_code": "<<REASON HERE>>",
    "doc_url": "https://docs.stripe.com/error-codes#card-declined",
    "message": "Your card was declined.",
    "type": "card_error"
  }
}

{
  "object": {
    "id": "du_Rk9W3Yi5RKxXzXFt",
    "object": "dispute",
    "charge_id": "ch_seSUkhmuVAYyNPZw",
    ...
    "status": "needs_response"
  }
}

{
  "object": {
    "id": "du_KedhxqJVZuR2lLJ7",
    "object": "dispute",
    "charge_id": "ch_WbxomdDj0GsxwUsS",
    ...
    "is_charge_refundable": true,
    ...
    "status": "warning_needs_response"
  }
}

{
  "object": {
    "id": "du_XQodBWgNjDN5yTQL",
    "object": "dispute",
    "charge_id": "ch_NVXIL4Wlc2Eb2tjs",
    ...
    "status": "won"
  }
}

{
  "object": {
    "id": "du_ItCNAhZDMmF5iVYg",
    "object": "dispute",
    "charge_id": "ch_qHSlJrPGIr2sYv1Y",
    ...
    "status": "lost"
  }
}

{
  "object": {
    "id": "du_LZRJkcU7AS8T1slo",
    "object": "dispute",
    "charge_id": "ch_rtWMoxmCUzd22F0h",
    ...
    "status": "warning_closed"
  }
}

{
  "object": {
    "id": "du_48EQjt2NDz3TXOeV",
    "object": "dispute",
    "charge_id": "ch_Ifet55QJsWrg3aE1",
    ...
    "status": "needs_response"
  }
}

{
  "id": "re_kD8N4a71OrHB4QdD",
  "object": "refund",
  "amount": "<<FULL AMOUNT>>",
  "charge": "ch_YkDhOD4nsnB2GVqs",
  ...
  "payment_intent": "pi_2ErmWWWEF8Nnh6NY", // if you're using PaymentIntents
  ...
  "status": "succeeded"
}

{
  "id": "re_zWSywFW05NxY6LRC",
  "object": "refund",
  "amount": "<<PARTIAL AMOUNT>>",
  "charge": "ch_yFPCtF8bKqmCztIG",
  ...
  "payment_intent": "pi_yMHx6SkavXCE1pX2", // if you are using PaymentIntents
  ...
  "status": "succeeded"
}

Stripe の Postman コレクション

Postman は、広く利用されている API 開発ツールです。Stripe の導入をよりシンプルにするために、導入のサーバー側コンポーネントをテストする際に必要なツールとともに決済専用の Postman コレクションをご用意しております。

コレクションをインポートする

まず、Postman アプリにアクセスする必要があります。ブラウザバージョンまたはデスクトップバージョンを使用できます。アプリを起動したら、コレクションをインポートします。

Web でこのプロセスを開始するには、左上隅にあるインポートボタンをクリックしてから、Link オプションをクリックします。Payments コレクションの Link を挿入します。Postman のデスクトップアプリを使用している場合は、File (ファイル) > Import (インポート) をクリックします。正常にインポートされると、Collections の下にコレクションが表示されます。

インポートダイアログ

回収を使用する

コレクションを使用するには、先ほどインポートしたコレクションに移動して、Variables (変数) をクリックします。テスト環境の Stripe シークレットキーを Stripe ダッシュボードからコピーして、Initial Value (初期値) フィールドに貼り付けます。この手順が完了すると、リクエストの実行準備が整います。

他の変数は、回収の実行時にスクリプトによって入力されます。たとえば、顧客、価格、請求、PaymentIntent を作成する場合は、システムは、回収のスクリプトを使用してその ID を保存し、返金の発行などの後続のリクエストで使用できるようにします。

Postman 回収にシークレットキーを追加する