新しい返金(トリガー)
このピースでできること
- Stripeで返金(Refund)が作成されたことを検知したら、ワークフローを開始します。
- 請求ID(Charge ID)や支払い意図ID(Payment Intent ID)で絞り込めます。
Stripe の接続方法
Stripe のシークレット API キーを入力して接続します。
シークレット API キーの取得手順
- Stripe ダッシュボード にログインします
- 左メニューの 開発者(Developers) をクリックします
- 「API キー(API keys)」 を開きます
- 「シークレットキー(Secret key)」 の 「表示(Reveal live key)」 をクリックします
- 表示されたシークレットキー( または テスト用 )をコピーします
- 接続画面の 「Secret API Key」 欄に貼り付けます
本番環境では から始まるキーを使用してください。テスト目的の場合は から始まるキーを使用できます。
ピースの設定項目
1. 請求ID(任意)
- 特定のチャージ(ch_...)に対する返金だけを対象にしたい場合に入力します。
2. 支払い意図ID(任意)
- 特定のPayment Intent(pi_...)に対する返金だけを対象にしたい場合に入力します。
取得できる情報
Stripeの 通知から、作成された返金(Refund)の情報を取得できます。
| 実際のキー | 内容・条件 |
|---|---|
| / | 対象データのIDと種類。イベント全体のIDではありません。 |
| 対象データの作成日時(Unixタイムスタンプ)。 | |
| Stripe側で設定した追加情報。未設定の場合は空です。 | |
| / | 返金額・通貨。金額は通貨の最小単位です。 |
| / | 返金対象のCharge ID・PaymentIntent ID。関連付けによりnullなどの場合があります。 |
| / | 返金の現在の状態・理由。理由が未指定の場合はnullなどになります。 |
- 出力はWebhook内の そのものです。後続ステップでは などを直接参照します。イベント全体の という階層にはなりません。
- 項目の有無やnull、関連IDと展開済みオブジェクトの違いはStripeのAPI版・通知内容・設定によって異なります。
- テストでは既存の返金を最大5件取得します。設定した請求ID・支払い意図IDの絞り込みはテストには適用しません。
- 通常通知では指定した ・ の両条件に一致する場合のみ出力します。返金作成時の状態は で確認してください。
出力例(抜粋)
キーの使い方を示す架空例です。実際の値や全項目を示すものではありません。