テスト環境環境とユースケース

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

テスト環境

テスト環境では、テスト用のクレジットカードに請求するほか、テスト用の商品と価格を作成することができます。また、テスト環境を使用して取引をシミュレーションし、実装が正常に機能することを確認できます。この機能により、本番環境に移行して実際の支払いを処理する前に、Stripe 実装のバグやエラーを確認することができます。

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

テスト環境と本番環境

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

ダッシュボードのテスト環境トグルが、実装環境のコードに影響を与えることはありません。コードの動作に影響を与えるのは、テスト環境と本番環境の 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_apDaIqqbtoY9yWpl",
    "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_qkBdnAyK82PGzCYl",
    "object": "dispute",
    "charge_id": "ch_FySzjnCTNmHUhb5F",
    ...
    "status": "needs_response"
  }
}

{
  "object": {
    "id": "du_akd8fU4CmNSxdOZZ",
    "object": "dispute",
    "charge_id": "ch_51h3XxU00zeZAr6U",
    ...
    "is_charge_refundable": true,
    ...
    "status": "warning_needs_response"
  }
}

{
  "object": {
    "id": "du_DjjFcEwVCBevY0ck",
    "object": "dispute",
    "charge_id": "ch_pAlRv0nsd2cjl1AQ",
    ...
    "status": "won"
  }
}

{
  "object": {
    "id": "du_wgBZxWN1GGwahomR",
    "object": "dispute",
    "charge_id": "ch_yJeFiw1QG2tjXhlj",
    ...
    "status": "lost"
  }
}

{
  "object": {
    "id": "du_hI2VUOTlBjyc8067",
    "object": "dispute",
    "charge_id": "ch_T9ToQCGgvI2ExSvw",
    ...
    "status": "warning_closed"
  }
}

{
  "object": {
    "id": "du_uhiS4Th7bEBWsr8o",
    "object": "dispute",
    "charge_id": "ch_1I2gYPCXzzmrDuZA",
    ...
    "status": "needs_response"
  }
}

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

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