ウェブフック

本サービスで発生する各種イベントの結果は「ウェブフック」として、それぞれの指定先URL（ローカルURLは指定不可）にHTTP POSTメソッドで送信されます。

ウェブフックは、管理画面＞ウェブフック＞ウェブフック追加　から設定できます。
複数のイベントで同じURLを、チェックボックスで指定することも可能です。

作成したウェブフックのURL、Authorizationヘッダー、トリガーは、後から変更することもできます。

Authorizationヘッダーとは、サーバーでの不正を防ぐためにリクエストの受け取りに認証を必要としたい場合に指定することができる6文字以上の任意の値です。

弊社ウェブフックのAuthorizationヘッダーに加盟店さまのAuthorizationヘッダーと同じ値を指定することで、
加盟店さまサーバーの認証を受けてウェブフックを送信することができます。

※通知内容の各オブジェクトの説明、ウェブフック情報の取得・変更処理のAPIについてはこちら

注意事項

ウェブフックはベストエフォートのため、通知の成功や通知速度を保証するものではありません。
決済の結果を短時間で加盟店さまのページで次の処理を行いたい場合は、APIのリクエストで課金情報の取得(課金:GET)、もしくはウィジェットのパラメータに記述を追加することでコールバックのイベントをリアルタイムで受け取ることを推奨します。

※3-Dセキュア認証の実装について

「3DSステータス更新」のトリガーを設定すると、カード登録（リカーリングトークン）の3-Dセキュア認証を利用された時に認証結果の通知を受け取ることが出来ます。
data.three_ds.statusの値が変化されるたびに通知が送信されます。
例：

1. リカーリングトークンを作成、初期ステータス：pending
2. 3DS実行の準備が完了、認証待ちの状態：awaiting（ステータスが変化したタイミングで通知）
3. 認証処理が終了、結果が反映：successful , failed（ステータスが変化したタイミングで通知）

ウェブフックの失敗後の挙動

ウェブフックの通知が失敗した場合、返却されたエラーコードによってリトライを行います。
失敗により停止したウェブフックは管理画面・もしくはAPIで再開する必要があります。

リトライ間隔は、1回目は1分でその後指数関数的に増加※し、最大は15分です。
※1分、2分、4分、8分、、と間隔が伸びていくこと

レスポンスステータスコード	処理
2xx	成功のためリトライしない
3xx	リトライせず、失敗後即停止する
4xx、500、501、502	初回含む最大10回のリトライを行い、最大回数に達すると停止する
5xx（500-502以外） ※当社側、加盟店さま側の3秒以上のレスポンスのタイムアウト時含む	初回含む最大10回のリトライを行い、最大回数に達しても停止しない

ウェブフック失敗・停止時のお知らせ機能

管理画面より、ウェブフックが失敗・停止した際にメール通知を受け取る設定ができます。

必要な場合は、管理画面＞一般設定＞一般＞通知　の「ウェブフック」の各項目を有効にしてください。

イベント名の一覧

※イベントごとに取得できる情報の一覧やパラメータの説明、ステータスについては各リソースタイプのリンク先よりご確認ください。

イベント名	通知の契機	管理画面でのトリガー名	リソースタイプ
charge_updated	都度の課金申込が完了し、ステータスが authorized（オーソリ済） awaiting（入金待ち：銀行振込やコンビニ決済で発生） のいずれかに更新された時	課金情報／ステータスの更新	課金
charge_finished	都度の課金処理が完了し、ステータスが canceled（返金済み） error（エラー） failed（失敗） successful（成功） のいずれかに更新された時	課金	課金
subscription_payment	定期課金の課金が成功した時	定期課金成功	定期課金
subscription_completed	回数または総額を指定した定期課金の、すべての支払が完了した時 （または分割払いが選択された場合、charge_finishedと並行）	定期課金完了	定期課金
subscription_failure	定期課金が失敗し、ステータスが unverified（待機中：定期課金を作成し、初回課金を待機中） unconfirmed（作成失敗：初回課金に失敗し、定期課金が稼働していない） unpaid（リトライ待ち） のいずれかに更新された時	定期課金失敗	定期課金
subscription_canceled	定期課金のステータスが canceled（永久停止：リクエストで移行し再開不可） に更新された時	定期課金永久停止	定期課金
subscription_suspended	定期課金のステータスが suspended（一時停止：管理画面で「一時停止」ボタンを押下、リトライ回数の超過、リクエストのいずれかで移行） に更新された時	定期課金一時停止	定期課金
subscription_created	新しい定期課金リソースのレコードが作成された時	定期課金作成	定期課金
token_created	トークンが作成された時	トークン作成	トランザクショントークン
token_updated	トークンが更新された時	トークン更新	トランザクショントークン
token_cvv_auth_updated	トークンのdata.cvv_authorized.statusが更新された時。	CVV認証ステータス更新	トランザクショントークン
refund_finished	返金（Refund）が完了 successful（成功） failed（失敗）	返金	返金
recurring_token_deleted	リカーリングトークンが削除された時	リカーリングトークン削除	トランザクショントークン
token_replaced	リカーリングトークンが更新された時	リカーリングトークン更新	トランザクショントークン
cancel_finished	キャンセルの状態が error（エラー） failed（失敗） successful（成功） になった時	キャンセル完了	キャンセル
customs_declaration_finished	WeChat Pay（オンライン）の三単合一における「税関申告」が完了	税関申告完了	–
token_three_ds_updated	リカーリングトークンの3-Dセキュアのステータスが更新された時 data.three_ds.statusの変化を確認できます ・awaiting：認証の準備が出来ている状態 ・successful：認証に成功した状態 ・failed：認証に失敗した状態 ・error：予期せぬエラーになった状態	3DSステータス更新	トランザクショントークン