テストのユースケース

Stripe のテスト環境とサンドボックスでは、実際の請求や支払いを行うことなく、構築したシステムをテストできます。これらの環境は、実際の取引に影響を与えたり、実際の資金を移動させたりせずに、実際のオブジェクトの作成をシミュレートします。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 キーは、コードの動作に影響します。テスト環境と本番環境の 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_lQ6ANCE2eV4YY0iG",
    "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_IN3Wu4dYsZ2AlmqC",
    "object": "dispute",
    "charge_id": "ch_g2ZQvmy7nVUugneC",
    ...
    "status": "needs_response"
  }
}

{
  "object": {
    "id": "du_vv37Gxqnx5Kq7Ucg",
    "object": "dispute",
    "charge_id": "ch_n78Zg6VEvYQqTbGq",
    ...
    "is_charge_refundable": true,
    ...
    "status": "warning_needs_response"
  }
}

{
  "object": {
    "id": "du_DSTw2ACOxcTfFvbj",
    "object": "dispute",
    "charge_id": "ch_HpUxArrCn1Rt1TAG",
    ...
    "status": "won"
  }
}

{
  "object": {
    "id": "du_3NdGHKNfewHQlMD5",
    "object": "dispute",
    "charge_id": "ch_8ezLvRz51pn7YOND",
    ...
    "status": "lost"
  }
}

{
  "object": {
    "id": "du_6e4OjP4Mmkb7lUGz",
    "object": "dispute",
    "charge_id": "ch_xWiYodDbik0GQcDl",
    ...
    "status": "warning_closed"
  }
}

{
  "object": {
    "id": "du_p4QY7WOPzCsFDcRJ",
    "object": "dispute",
    "charge_id": "ch_t0R6gJq00NqcOQbi",
    ...
    "status": "needs_response"
  }
}

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

{
  "id": "re_dEYqAgjGdBcAF0LS",
  "object": "refund",
  "amount": "<<PARTIAL AMOUNT>>",
  "charge": "ch_NCex5ocyOgWZOSVU",
  ...
  "payment_intent": "pi_7vl5D8uFcWDPjzR6", // 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 コレクションにシークレットキーを追加する