銀行Webhookのイベントは、本番環境とサンドボックスのアプリケーションに対して送信されます。
他のイベントと同様に、Webhookの送信先ごとに、その送信先のイベントフィルターでイベントを選択してください。
エンベロープ、署名ヘッダー、再試行については、Webhookを参照してください。
イベント
すべてのイベントには、共通フィールドの
event_id、webhook_type、timestamp、created_at、application_id、environment も含まれます。
bank.link.* イベントのフィールドは data の下にあります。接続、データ、同期のイベントのフィールドは最上位にあります。
ended_by の値は end_user、bank、customer、unknown のいずれかです。
すべてのイベントの正確なスキーマは APIリファレンス にあります。
例
使い方
- 新しいデータ。
bank.data.updatedはシグナルのみで、データが送信されることはありません。保存済みのカーソルを使って変更フィードを呼び出してください。変更がなかった同期を含め、すべての同期を確認したい場合にのみbank.sync.completedを使用してください。 - オンボーディング。 アカウントを読み取る前に
bank.connection.createdを待ち、完全な履歴に依存する前にbank.connection.history_completeを待ってください。 - 同意。
bank.connection.consent_expiringを受信したら、本人に更新を依頼してください。bank.connection.renewal_requiredを受信した場合、データは引き続き読み取れますが、同期は行われなくなります。 - 停止。
bank.connection.revokedを受信したら、その接続に対する独自のフィードを停止し、保存済みのデータを削除するかどうかを判断してください。 - 重複。 すべてのイベントを冪等に扱ってください。イベントIDをキーにし、同じイベントが時々2回届く場合があることを想定してください。
- ブラウザを信頼しないでください。 リンクの確認は、ページから送られたリンクIDではなく、
bank.link.completedまたはGET /v3/bank/links/{id}/を使って行ってください。
次のステップ
- 会計向けの継続的な銀行フィード
- サンドボックス: Didit Test Bank がこれらのイベントを発生させます。