24.2. クレジットカードゲートウェイとしての Stripe の設定

3scale API プロバイダーとして、Stripe を支払いゲートウェイとして管理ポータルおよびデベロッパーポータルを設定し、クレジットカードゲートウェイとして Stripe を使用して API に対するサブスクリプションからの支払いを受け取ります。

前提条件

  • Stripe アカウントが必要である。

    • Stripe では、ビジネスまたはプロジェクトごとに個別の Stripe サブアカウントを使用することをお勧めする。
    • 複数のアカウント については、Stripe のドキュメントを参照すること。
  • Stripe 管理者パーミッションが必要である。

手順

Stripe を支払いゲートウェイとして 3scale を設定するには、以下の手順に従います。

  1. 3scale 管理ポータルでの Billing API スコープを設定したアクセストークンの生成l
  2. Stripe からのキーおよび Webhook シークレットの取得
  3. 3scale 管理ポータルでの課金の設定
  4. 3scale デベロッパーポータルでのクレジットカード情報の編集
  5. unsuccessfully charged 電子メールレスポンスのテキストを更新する

24.2.1. 3scale 管理ポータルでの Billing API スコープを設定したアクセストークンの生成

  1. 3scale 管理ポータルで、Account Settings > Personal > Tokens の順に移動します。

  2. Billing API スコープを設定して 読み取り/書き込み のトークンを作成します。

    1. Add Access Token をクリックします。
    2. トークンの名前を指定します。
    3. スコープに Billing API を選択します。
    4. パーミッションレベルに 読み取り/書き込み を選択します。
    5. Create Access token をクリックします。

    6. アクセストークンをコピーします。

      • アクセストークンをファイルテキストにコピーしてください。これ以降アクセストークンは表示されません。
    7. トークンの生成を完了するには、I have copied the token をクリックします。

手順に戻る。

24.2.2. Stripe からのキーおよび Webhook シークレットの取得

注記
  • Stripe で Webhook を設定する必要があります。
  • Webhook を使用して、支払いが成功したことを 3scale に通知します。
  • その後、3scale は請求書の状態を更新し、それ以上の請求を防止します。

Stripe アカウントで、Secret Key および Publishable Key を取得します。

  1. Stripe ダッシュボードを開きます。
  2. Stripe ドキュメントの手順に従って、API キーを確認してください。
  3. Secret Key および Publishable Key をコピーします。

引き続き、Stripe アカウントで Webhook Signing Secret を作成します。

  1. Developers > Webhooks の順に移動します。
  2. Add endpoint をクリックします。

  3. 以下のエンドポイント URL を入力します。 

    https://<Your-provider-admin-domain>/api/payment_callbacks/stripe_callbacks?access_token=<value-of-access-token>
  4. Events to send に payment_intent.succeeded を追加します。
  5. Add endpoint をクリックします。
  6. クリックして作成した Webhook の署名シークレットを表示し、このシークレットを書き留めます。これは Webhook Signing Secret です。

手順に戻る。

24.2.3. 3scale 管理ポータルでの課金の設定

3scale 管理ポータルで以下を行います。

  1. Audience > Billing > Charging & Gateway の順に移動します。
  2. Charging enabled を選択し、Save をクリックします。
  3. Credit card gateway > Gateway で、Stripe をゲートウェイとして選択します。
  4. 「Stripe からのキーおよび Webhook シークレットの取得」で Stripe アカウントから取得した Secret Key、Publishable Key、および Webhook Signing Secret を追加します。
  5. Save をクリックします。

手順に戻る。

24.2.4. 3scale デベロッパーポータルでのクレジットカード情報の編集

  1. 開発者アカウントを使用して 3scale デベロッパーポータルにログインします。
  2. Settings > Credit Card Details の順に移動します。
  3. クレジットカード情報 (クレジットカード番号、有効期限、および CVC) を追加します。
  4. Save details をクリックします。

手順に戻る。

24.2.5. unsuccessfully charged 電子メール応答のテキストを更新する

SCA 支払いの修正に関連して、invoice_messenger_unsuccessfully_charged_for_buyer.text.liquid メールのテキストには、3scale 2.10 での手動更新が必要です。

  1. 3scale 管理ポータルで Audience > Messages > Email Templates の順に移動します。
  2. Invoice charge failure for buyer with retry を選択します。
  3. Override をクリックします。

  4. テンプレートのメッセージを更新します。以下は、課金に失敗した場合のメールレスポンスで使用される完全なテキストです。 

    Dear {{ account.name }},

Thank you for using our service.

We're sorry to inform you that your last payment was declined.
This may have been caused by a few common reasons:

- A new authentication policy enforced by your bank
- An expired credit card
- Insufficient funds on the account

To continue using your service, verify the status of your credit card and update or re-enter the credit card details at {{payment_url}}.

If you need help, don't hesitate to contact us at {{ provider.finance_support_email }}.

Best regards,
The {{ provider.name }} API Team
  5. Create Email Template をクリックします。

以下の手順により、unsuccessfully charged メールのレスポンスのメールテンプレートを更新しました。

手順に戻る。

関連情報