Ctrlk
System Status
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Key event types

Understand the key event types that your integration might want to monitor

There are hundreds of types of events in the Digital River APIs. Most integrations, however, only need to configure webhooks to listen for a small number of them.

For more information on event types, refer to Webhooks.

On this page, you'll find example payloads for:

Remember that the examples on this page aren't meant to be comprehensive. The actual data each event contains depends on that order's configuration. For example, cross-border order.* events typically have landed costs, orders with applied VAT identifiers generate events that contain taxIdentifiers[], and subscriptions result in order.* events with subscriptionInfo.

Core events

Certain core events notify you when payments are processed, fraud is detected, and refunds occur. For each of the following event types, this section provides example payloads and links to additional information:

order.accepted

For details, refer to the following pages:

order.review_opened

Refer to the in-process fraud review event section on the Processing orders page for details.

order.pending_payment

Refer to the pending charge authorization event section processing orders pages for details.

order.blocked

Refer to the fraud block event section on the Processing orders page for details.

order.charge.failed

Refer to details of the charge authorization failure event section on the Processing orders page.

order.cancelled

Refer to the order cancelled event section on the Processing orders page for details.

fulfillment.created

Refer to the fulfillment created event section on the Capturing and cancelling payment charges page for details.

order.fulfilled

Refer to the order fulfilled event section on the Capturing and cancelling payment charges page for details.

order.charge.capture.complete

Refer to the charge capture complete and failed events section on the Capturing and cancelling payment charges page for details.

order.charge.capture.failed

Refer to the charge capture complete and failed events section on the Capturing and cancelling payment charges page for details.

order.charge.cancel.complete

For details, refer to the charge cancel success event section on the Capturing and cancelling payment charges page.

order.complete

For details, refer to the order complete event section on the Capturing and cancelling payment charges page.

order.invoice.created

For details, refer to the handling the order invoice created event section on the Accessing invoices and credit memos page.

order.credit_memo.created

For details, refer to handling the credit memo created event section on the Accessing invoices and credit memos page.

order.refunded

For details, refer to Completed refunds on the Issuing refunds page.

order.chargeback

The data.object of this type of event is a sales transaction. For details, refer to Disputes and chargebacks.

refund.pending

Refer to the pending refunds section on the Issuing refunds page for details.

refund.pending_information

Refer to the Refunding asynchronous payment methods page for details.

refund.complete

Refer to the completed refunds section on the Issuing refunds page for details.

refund.failed

Refer to the failed refunds section on the Issuing refunds page for details.

order.charge.refund.complete

order.charge.refund.failed

checkout_session.order.created

For details, refer to Handling completed checkout-sessions.

Subscription events

If you're using Digital River's subscription service, you'll most likely want to configure a webhook(s) to listen for the following types of events:

subscription.created

For details:

subscription.deleted

Refer to Deleting subscriptions on the Subscription management page for details.

subscription.extended

For details, refer to the following topics:

subscription.failed

Refer to Subscription failures on the Subscription management page for details.

subscription.payment_failed

Refer to Payment failures on the Subscription management page for details.

subscription.source_invalid

For details, refer to:

subscription.lapsed

For details, refer to:

subscription.reminder

Refer to Sending a reminder on the Subscription management page for details.

subscription.updated

Refer to Updating subscriptions on the Subscription management page for details.

PreviousEventsNextAll event types

Last updated