回復 - Dodo Payments Documentation

放棄されたカート回復イベント

以下のWebhookイベントは放棄されたカートの回復ライフサイクルを追跡します:

Event	Description
`abandoned_checkout.detected`	放棄されたチェックアウトが検出されました。支払いが放棄された（失敗または不完全）と判断され、回復ワークフローが開始されたときに送信されます。
`abandoned_checkout.recovered`	顧客が回復リンクを通じて支払いを完了しました。`recovered_payment_id` フィールドには成功した支払いのIDが含まれています。

放棄されたチェックアウトペイロードフィールド

string

必須

放棄された元の支払いです。これを使用して製品、金額、通貨の詳細を調べてください。

string

必須

この abandoned checkout が属するブランド。

string

必須

チェックアウトを中断した顧客。

string

必須

チェックアウトが中断された理由。次のいずれかです:

payment_failed — 顧客が支払いを試みたが、失敗した
checkout_incomplete — 顧客がチェックアウトにアクセスしたが、支払いを試みなかった

string

必須

この recovery attempt の現在のライフサイクル状態。次のいずれかです:

abandoned — 検出済みですが、まだメールは送信されていない
recovering — 1通以上の recovery email が送信された
recovered — 顧客が支払いを完了した
exhausted — すべてのメールが送信された、または新しいチェックアウトが見つかった
opted_out — 顧客が配信登録を解除した

string

必須

チェックアウトが中断されたと検出された時刻の ISO 8601 timestamp。

string | null

成功した recovery payment の payment ID。チェックアウトが復旧されるまでは null です。

例: ACR Webhooks の処理

app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;

  switch (event.type) {
    case 'abandoned_checkout.detected':
      console.log(`Checkout abandoned: ${event.data.payment_id}`);
      console.log(`Reason: ${event.data.abandonment_reason}`);
      // Track abandonment in your analytics
      await trackAbandonment(event.data);
      break;

    case 'abandoned_checkout.recovered':
      console.log(`Checkout recovered: ${event.data.payment_id}`);
      console.log(`Recovery payment: ${event.data.recovered_payment_id}`);
      // Grant access, update records
      await handleRecovery(event.data);
      break;
  }

  res.json({ received: true });
});

Dunning Events

次の webhook events は、サブスクリプションの Dunning lifecycle を追跡します:

Event	Description
`dunning.started`	`on_hold` になった、または顧客によってキャンセルされたサブスクリプションに対して、Dunning attempt が作成された。
`dunning.recovered`	顧客が payment method を更新し、その結果として支払いが成功した。`payment_id` フィールドには、成功した支払いの ID が含まれる。

Dunning Attempt Payload Fields

string

必須

Dunning attempt をトリガーしたサブスクリプション。

string

必須

この Dunning attempt が属するブランド。

string

必須

サブスクリプションを所有する顧客。

string

必須

督促をトリガーしたサブスクリプションの状態。次のいずれか:

on_hold — 支払い失敗により更新が停止しました
cancelled — 顧客が顧客ポータルからキャンセルしました

string

必須

この Dunning attempt の現在のライフサイクル状態。次のいずれかです:

recovering — Dunning emails が送信されている
recovered — 顧客が payment method を更新し、支払いが成功した
exhausted — すべてのメールが送信された、またはサブスクリプションの状態が変更された

string

必須

Dunning attempt が作成された時刻の ISO 8601 timestamp。

string | null

成功した recovery payment の payment ID。復旧中は null です。

例: Dunning Webhooks の処理

app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;

  switch (event.type) {
    case 'dunning.started':
      console.log(`Dunning started for subscription: ${event.data.subscription_id}`);
      console.log(`Trigger: ${event.data.trigger_state}`);
      // Track dunning in your system
      await trackDunning(event.data);
      break;

    case 'dunning.recovered':
      console.log(`Subscription recovered: ${event.data.subscription_id}`);
      console.log(`Recovery payment: ${event.data.payment_id}`);
      // Reactivate access, update records
      await handleDunningRecovery(event.data);
      break;
  }

  res.json({ received: true });
});

完全な Dunning lifecycle を追跡するには、dunning.started と dunning.recovered の両方を subscribe してください。dunning.started を使用して、システム内の grace period を一時停止したり、リスクのあるサブスクリプションにフラグを付けたりできます。

Abandoned Cart Recovery

ACR email sequences と discount incentives を設定します。

Subscription Dunning

期限切れのサブスクリプション向けに Dunning email sequences を設定します。

Subscription Webhooks

subscription.on_hold や subscription.cancelled など、関連するサブスクリプションのライフサイクルイベント。

Webhook Payload Schema

Webhook payload for abandoned_checkout.detected and abandoned_checkout.recovered events

abandoned_at

string<date-time>

必須

abandonment_reason

enum<string>

必須

利用可能なオプション:

payment_failed,

checkout_incomplete

brand_id

string

必須

Brand id this abandoned checkout belongs to

customer_id

string

必須

payment_id

string

必須

status

enum<string>

必須

利用可能なオプション:

abandoned,

recovering,

recovered,

exhausted,

opted_out

recovered_payment_id

string | null

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

回復

放棄されたカート回復イベント

放棄されたチェックアウトペイロードフィールド

例: ACR Webhooks の処理

Dunning Events

Dunning Attempt Payload Fields

例: Dunning Webhooks の処理

Abandoned Cart Recovery

Subscription Dunning

Subscription Webhooks

Webhook Payload Schema

​放棄されたカート回復イベント

​放棄されたチェックアウトペイロードフィールド

​例: ACR Webhooks の処理

​Dunning Events

​Dunning Attempt Payload Fields

​例: Dunning Webhooks の処理

Abandoned Cart Recovery

Subscription Dunning

Subscription Webhooks

​Webhook Payload Schema

放棄されたカート回復イベント

放棄されたチェックアウトペイロードフィールド

例: ACR Webhooks の処理

Dunning Events

Dunning Attempt Payload Fields

例: Dunning Webhooks の処理

Webhook Payload Schema