テストのユースケース

テスト環境やサンドボックスなど、Stripe のテスト環境では、実際の請求や支払いを行うことなく、構築したシステムをテストできます。これらの環境は、実際の取引に影響を与えたり、実際の資金を移動させたりせずに、実際のオブジェクトの作成をシミュレートします。Stripe が用意した品質保証 (QA) テストのユースケースを使用して、テストプロセスを支援する Postman コレクションをインポートすることをお勧めします。

テスト環境

In a testing environment, you can charge test credit cards and create test products and prices. These environments let you simulate transactions to make sure that your integration works correctly. This feature helps to identify any bugs or errors in your Stripe implementation before you go live with actual payments. Learn how to decide between using test mode and Sandboxes.

Stripe アカウントを作成すると、Stripe ダッシュボードでテスト API キーのセットを確認できます。これらの API キーを使用して、Stripe API にリクエストを行うことで、シミュレートされたデータを作成・取得できます。実際の支払いの受け付けを開始するには、本番環境利用を申請し、アカウント選択ツールを使用してテスト環境を終了してから、構築したシステムで本番環境の API キーを使用する必要があります。Stripe は実装状態をテストするためのリソースをいくつか用意しています。

Compare testing environments

テスト環境とサンドボックスは、実際の取引に影響を与えたり、実際の資金を動かしたりすることなく、実際のオブジェクトの作成をシミュレートできる環境です。それぞれの利用場面がいつなのかを理解することは、テスト戦略を構築する上で有用です。

We recommend using Sandboxes for your testing needs because they offer additional functionality and greater flexibility compared to test mode. By transitioning to Sandboxes, you can enhance your testing capabilities with multiple environments, granular access control, and isolated settings, allowing you to build a more robust and comprehensive testing strategy.

Transition from test mode to Sandboxes

To transition from test mode to Sandboxes in the Dashboard:

1. Create a sandbox, then invite the users who need access to it.
   • When you grant a team member the Sandbox User role, you’re giving them access to create sandboxes associated with your live business account and delete sandboxes they’ve created. Unlike test mode, where all users had automatic access, only those with the Sandbox User role, Admin roles, Developer role, or Sandbox Admin role can access sandboxes.
2. Obtain new test API keys and your account ID for your sandbox.
3. Set up relevant testing data such as test products, customers, subscriptions, and payment methods.
   • (Optional) Set up test clocks, which help you test your Billing integration to make sure it behaves as expected. When you use test clocks, you simulate the forward movement of time in the sandbox, causing Billing resources such as Subscriptions to change state and trigger webhook events. This allows you to see how your integration handles scenarios, such as a payment failure for a quarterly or annual renewal, without waiting extended periods.
4. Update any part of your testing processes that depends on specific test object IDs. This changes when you create new objects in a sandbox.

Differences in functionality between test mode and Sandboxes

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

テスト環境と本番環境の比較

すべての Stripe API リクエストは、テスト環境または本番環境のいずれかで行われます。一方の環境の API オブジェクトには、もう一方の環境からはアクセスできません。たとえば、テスト用の Product オブジェクトを本番環境の支払いに含めることはできません。

ダッシュボードのテスト環境を使用しても、実装コードには影響しません。テスト環境と本番環境の API キーは、コードの動作に影響します。テスト環境と本番環境の API キーは、コードの動作に影響します。

テストカード番号

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

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

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

テストデータを削除する

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

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

削除プロセスが行われている間、テスト環境は一時的に使用できなくなります。

テストメール

デフォルトでは、テスト環境の場合は Stripe から顧客にメールを送信しません。たとえば、サンドボックスで請求書を支払っても、顧客に領収書メールは送信されません。テスト環境で API を使用して請求書を確定した場合も、顧客に領収書メールは送信されません。

テスト環境で Stripe から顧客にメールを送信するように設定する場合は、ダッシュボードで次の操作を実行してください。

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

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

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

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

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

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

{
  "error": {
    "charge": "ch_weeKNHkwmogyK5Mc",
    "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_GQPbyuhbocezuPK1",
    "object": "dispute",
    "charge_id": "ch_t0Y5FbMDNPBRcdGb",
    ...
    "status": "needs_response"
  }
}

{
  "object": {
    "id": "du_FlJryYeC4heypR2k",
    "object": "dispute",
    "charge_id": "ch_dPvPI0qIrJ7Ivu9c",
    ...
    "is_charge_refundable": true,
    ...
    "status": "warning_needs_response"
  }
}

{
  "object": {
    "id": "du_Ch3KAFhg2w9f4x06",
    "object": "dispute",
    "charge_id": "ch_XI5tMTByyzbn2ZUg",
    ...
    "status": "won"
  }
}

{
  "object": {
    "id": "du_BF5zTaQxTVIQ5VEG",
    "object": "dispute",
    "charge_id": "ch_cM6OLz3mSX8SAljK",
    ...
    "status": "lost"
  }
}

{
  "object": {
    "id": "du_MykesQsoH55NrrbT",
    "object": "dispute",
    "charge_id": "ch_Ot7qPXhHR6LqB4Ls",
    ...
    "status": "warning_closed"
  }
}

{
  "object": {
    "id": "du_v6crAR8vZ2QGFjqm",
    "object": "dispute",
    "charge_id": "ch_oljNKWTc47LWoWzF",
    ...
    "status": "needs_response"
  }
}

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

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

Stripe の Postman コレクション

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

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

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

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

インポートダイアログ

コレクションを使用する

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

他の変数は、コレクションの実行時にスクリプトによって入力されます。たとえば、customer、price、charge、PaymentIntent を作成する場合は、システムは、コレクションのスクリプトを使用してその ID を保存し、返金などの後続のリクエストで使用できるようにします。

Postman コレクションにシークレットキーを追加する