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.chargeback
order.accepted
order.acceptedFor details, refer to the following pages:
Handling an accepted order on the Processing orders page.
order.review_opened
order.review_openedRefer to the in-process fraud review event section on the Processing orders page for details.
order.pending_payment
order.pending_paymentRefer to the pending charge authorization event section processing orders pages for details.
order.blocked
order.blockedRefer to the fraud block event section on the Processing orders page for details.
order.charge.failed
order.charge.failedRefer to details of the charge authorization failure event section on the Processing orders page.
order.cancelled
order.cancelledRefer to the order cancelled event section on the Processing orders page for details.
fulfillment.created
fulfillment.createdRefer to the fulfillment created event section on the Capturing and cancelling payment charges page for details.
order.fulfilled
order.fulfilledRefer to the order fulfilled event section on the Capturing and cancelling payment charges page for details.
order.charge.capture.complete
order.charge.capture.completeRefer to the charge capture complete and failed events section on the Capturing and cancelling payment charges page for details.
order.charge.capture.failed
order.charge.capture.failedRefer to the charge capture complete and failed events section on the Capturing and cancelling payment charges page for details.
order.charge.cancel.complete
order.charge.cancel.completeFor details, refer to the charge cancel success event section on the Capturing and cancelling payment charges page.
order.complete
order.completeFor details, refer to the order complete event section on the Capturing and cancelling payment charges page.
order.invoice.created
order.invoice.createdFor details, refer to the handling the order invoice created event section on the Accessing invoices and credit memos page.
order.credit_memo.created
order.credit_memo.createdFor details, refer to handling the credit memo created event section on the Accessing invoices and credit memos page.
order.refunded
order.refundedFor details, refer to Completed refunds on the Issuing refunds page.
order.chargeback
order.chargebackThe data.object of this type of event is a sales transaction. For details, refer to Disputes and chargebacks.
refund.pending
refund.pendingRefer to the pending refunds section on the Issuing refunds page for details.
refund.pending_information
refund.pending_informationRefer to the Refunding asynchronous payment methods page for details.
refund.complete
refund.completeRefer to the completed refunds section on the Issuing refunds page for details.
refund.failed
refund.failedRefer to the failed refunds section on the Issuing refunds page for details.
order.charge.refund.complete
order.charge.refund.completeorder.charge.refund.failed
order.charge.refund.failedcheckout_session.order.created
checkout_session.order.createdFor 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.source_invalidsubscription.lapsed
subscription.created
subscription.createdFor details:
If you're using Prebuilt Checkout, refer to How Digital River processes your requests on the Processing subscription acquisitions page.
If you selected the Direct Integrations option, refer to Acquisition checkout response on the Handling subscription acquisitions page.
subscription.deleted
subscription.deletedRefer to Deleting subscriptions on the Subscription management page for details.
subscription.extended
subscription.extendedFor details, refer to the following topics:
Handling successful renewals on the Subscription management page.
subscription.failed
subscription.failedRefer to Subscription failures on the Subscription management page for details.
subscription.payment_failed
subscription.payment_failedRefer to Payment failures on the Subscription management page for details.
subscription.source_invalid
subscription.source_invalidFor details, refer to:
The Lifecycle of a subscription on the Subscriptions page
subscription.lapsed
subscription.lapsedFor details, refer to:
The Lifecycle of a subscription on the Subscriptions page
subscription.reminder
subscription.reminderRefer to Sending a reminder on the Subscription management page for details.
subscription.updated
subscription.updatedRefer to Updating subscriptions on the Subscription management page for details.
Last updated