Webhook Events Guide

Dodo Payments は、payment、subscription、dispute、payout、credit、または license key のライフサイクルの各段階で webhook event を発行します。このページでは、すべての event をリソース別に一覧します。詳細な payload schema と handler の例については、以下にリンクされている各リソースのページを参照してください。

Payment Events

Event	発生条件
`payment.succeeded`	payment が正常に処理されたとき。
`payment.failed`	カードの拒否、残高不足、その他のエラーにより payment attempt が失敗したとき。
`payment.processing`	payment が処理中のとき。
`payment.cancelled`	完了前に payment がキャンセルされたとき。

完全な payload schema については、Payment Webhooks を参照してください。

Refund Events

Event	発生条件
`refund.succeeded`	refund が正常に処理されたとき。
`refund.failed`	処理エラーやその他の問題により refund attempt が失敗したとき。

完全な payload schema については、Refund Webhooks を参照してください。

Dispute Events

Event	発生条件
`dispute.opened`	cardholder が payment に対する dispute を開始したとき。
`dispute.challenged`	dispute に異議を申し立てるための evidence が提出されたとき。
`dispute.accepted`	dispute が異議を申し立てられないまま承認されたとき。
`dispute.cancelled`	dispute が取り下げられた、またはキャンセルされたとき。
`dispute.expired`	解決されないまま response window を過ぎたとき。
`dispute.won`	dispute が加盟店側に有利な形で解決されたとき。
`dispute.lost`	dispute が cardholder 側に有利な形で解決されたとき。

詳細な payload schema と handler の例については、Dispute Webhooks を参照してください。

Subscription Events

Event	発生条件
`subscription.active`	subscription が正常に有効化され、定期 charge がスケジュールされたとき。
`subscription.updated`	subscription の任意の field が変更されたとき（polling を必要としないリアルタイム同期）。
`subscription.past_due`	renewal が失敗して grace period が開始されたとき。期限までは customer がアクセスを維持できます。
`subscription.on_hold`	renewal の失敗により subscription が一時的に保留されたとき。
`subscription.paused`	subscription が一時停止されたとき。
`subscription.unpaused`	一時停止中の subscription が再開されたとき。
`subscription.renewed`	subscription が次の billing period に向けて正常に更新されたとき。
`subscription.plan_changed`	subscription が upgrade、downgrade、または異なる add-on を伴う変更をされたとき。
`subscription.update_payment_method`	subscription の payment method が更新されたとき。
`subscription.cancelled`	merchant または customer によって subscription がキャンセルされたとき。
`subscription.failed`	mandate の作成中に subscription の作成が失敗したとき。
`subscription.expired`	subscription が契約期間の終了に達し、期限切れになったとき。

詳細な payload schema と handler の例については、Subscription Webhooks を参照してください。

License Key Events

Event	発生条件
`license_key.created`	product 用の新しい license key が作成されたとき。

完全な payload schema については、License Key Webhooks を参照してください。

Entitlement Grant Events

Event	発生条件
`entitlement_grant.created`	customer に対して新しい entitlement grant が作成されたとき。自動 fulfill される license-key grant と feature-flag grant は `status: "Delivered"` とともに届き、個別の `delivered` event は発生しません。手動 fulfill の license key を含むその他の grant は `Pending` とともに届きます。Entitlement Grant を参照してください。
`entitlement_grant.delivered`	grant の fulfill が完了したとき — license key が発行された、file link が解決された、または platform access が付与されたとき。
`entitlement_grant.failed`	grant の fulfill が失敗したとき。payload 内の `error_code` と `error_message` を確認してください。
`entitlement_grant.revoked`	access が取り消されたとき。payload 内の `revocation_reason` を確認してください。

詳細な payload schema、sample event、および完全な revocation_reason reference については、Entitlement Grant Webhooks を参照してください。

Credit Events

Event	発生条件
`credit.added`	customer に credit が付与されたとき（subscription、one-time purchase、add-on、または API 経由）。
`credit.deducted`	usage または manual debit によって credit が消費されたとき。
`credit.expired`	未使用の credit が、設定された有効期限を過ぎて失効したとき。
`credit.rolled_over`	cycle の終了時に、未使用の credit が新しい grant に繰り越されたとき。
`credit.rollover_forfeited`	max rollover count に達したため、credit が失われたとき。
`credit.overage_charged`	残高がゼロを超える usage に対して overage charge が適用されたとき。
`credit.overage_reset`	累積した overage charge がリセットされたとき（たとえば、新しい billing cycle の開始時）。
`credit.manual_adjustment`	手動で credit または debit の調整が行われたとき。
`credit.balance_low`	credit balance が設定された threshold を下回ったとき。

詳細な payload schema と handler の例については、Credit-Based Billing Webhooks を参照してください。

Recovery Events

Event	発生条件
`abandoned_checkout.detected`	未完了または失敗した checkout が 60 分後に検出されたとき。
`abandoned_checkout.recovered`	customer が recovery link を使用して payment を完了したとき。

詳細な payload schema、field の説明、handler の例については、Recovery Webhooks を参照してください。

Dunning Events

Event	発生条件
`dunning.started`	past due または on hold になった、あるいはキャンセルされた subscription に対して dunning attempt が開始されたとき。
`dunning.recovered`	customer が payment method を更新し、その結果として charge が成功したとき。

詳細な payload schema、field の説明、handler の例については、Recovery Webhooks を参照してください。

Payout Events

Payout event は、Dodo Payments から銀行口座へ資金が移動する状況を追跡します。ダッシュボードに表示される payout status を反映します。payload は、GET /payouts のエントリと同じ形式の payout object です。

Event	発生条件
`payout.created`	自動 payout cycle または cycle 外の処理によって payout が作成されたとき。
`payout.in_progress`	payout の支払期日が到来し、処理が開始されたとき。
`payout.on_hold`	payout が一時停止された、または review 対象になったとき。
`payout.success`	銀行口座への payout が settlement されたとき。
`payout.failed`	payout が失敗したとき。資金と fee は wallet に返金されます。

Payout event は terminal でも、厳密に順序付けられているわけでもありません。銀行が transfer を返却した場合、payout.failed は payout.success の後に届くことがあります。また、失敗した payout が後から回復した場合、payout.success は payout.failed の後に届くことがあります。payload の status は常に event type と一致するため、各 event のトップレベルにある timestamp を使用して最新の state を確認してください。

payout.created は以前、payout.not_initiated として発行されていました。既存の endpoint が payout.not_initiated で filter している場合は、引き続き一致するように filter を payout.created に更新してください。

詳細な payload schema、field の説明、handler の例については、Payout Webhooks を参照してください。

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Payment Events

Refund Events

Dispute Events

Subscription Events

License Key Events

Entitlement Grant Events

Credit Events

Recovery Events

Dunning Events

Payout Events

​Payment Events

​Refund Events

​Dispute Events

​Subscription Events

​License Key Events

​Entitlement Grant Events

​Credit Events

​Recovery Events

​Dunning Events

​Payout Events

Payment Events

Refund Events

Dispute Events

Subscription Events

License Key Events

Entitlement Grant Events

Credit Events

Recovery Events

Dunning Events

Payout Events