Event types

Understand the event types supported by Digital River.

The following topics list the events types we currently support. Every event type uses the following format: resource.event. Coding is easier when you know the event types use a consistent format.

Note: When an event occurs on a subresource like checkout.customer, it does not trigger the parent's update event.

Charge events

Event

Description

charge.cancelled Defines a cancelled charge

This occurs whenever a charge is cancelled.

charge.pending Defines a pending charge

This occurs whenever a charge is pending.

Checkout events

Event

Description

checkout.created Defines a new checkout

This occurs whenever a checkout is created.

checkout.deleted Defines a deleted checkout

This occurs whenever a checkout is deleted.

checkout.updated Defines an updated checkout

This occurs whenever a checkout is updated.

Customer events

Event

Description

customer.created Defines a new customer

This occurs whenever a customer is created.

customer.deleted Defines a deleted customer

This occurs whenever a customer is deleted.

customer.source.created Defines a new customer source

This occurs whenever a source is attached to a customer.

customer.source.deleted Defines a deleted customer source

This occurs whenever a source is detached from a customer.

customer.updated Defines an updated customer

This occurs whenever a customer is updated.

File events

Event

Description

file.created Defines a new file

This occurs whenever a file is created.

file.deleted Defines a deleted file

This occurs whenever a file is deleted.

File Link events

Event

Description

fileLink.created Defines a new file link

This occurs whenever a file link is created.

fileLink.deleted Defines a deleted file link

This occurs whenever a file link is deleted.

fileLink.updated Defines an updated file link

This occurs whenever a file link is updated.

Fulfillment events

Event

Description

fulfillment.created Defines a new fulfillment

This occurs whenever an order item or an entire order is fulfilled by Global Fulfillment or a third party.

Order events

Event

Description

order.accepted

Defines an accepted order

This occurs whenever an order is not pending funds and is not pending fraud.

order.blocked Defines a blocked order

This occurs whenever an order may be pending funds or pending fraud.

order.cancelled

Defines a cancelled order

This occurs whenever the fulfiller cancels an order in full.

order.charge.cancel.complete

Defines a completed cancel for a charge

This occurs whenever a cancel request for a charge completes.

order.charge.cancel.failed

Defines a failed cancel for a charge

This occurs whenever a cancel request for a charge fails.

order.charge.cancel.pending

Defines a pending cancel for a charge

This occurs whenever a cancel request for a charge is pending.

order.charge.cancel.pending_information Defines a pending cancel for a charge that requires information.

This occurs whenever a cancel request for a charge is pending information.

order.charge.capturable Defines a capturable order charge

This occurs whenever there is a capturable order charge.

order.charge.capture.complete Defines the completed order charge capture

This occurs whenever an order charge capture completes. This is available for all payment methods, including PayPal and Direct Debit.

order.charge.capture.failed Defines a failed order charge capture

This occurs whenever an order charge fails.

order.charge.capture.pending Defines a pending order charge capture

This occurs whenever there is a pending order charge capture.

order.charge.completed Defines a completed order charge capture

This occurs whenever an order charge capture completes.

order.charge.failed Defines a failed order charge

This occurs whenever an order charge fails.

order.charge.pending Defines a pending order charge

This occurs whenever there is a pending order charge.

order.charge.refund.complete Defines the order charge refund

This occurs whenever an order charge refund completes.

order.charge.refund.failed Defines the failed order charge refund

This occurs whenever an order charge refund fails.

order.charge.refund.pending Defines the pending order charge refund

This occurs whenever an order charge refund is pending.*A

order.charge.refund.pending_information Defines an order charge refund that is pending information

This occurs whenever an order charge refund is pending information for a delayed payment method (such as, Wire Transfer and bPay).

order.chargeback

Defines a an order chargeback

This occurs whenever an order chargeback occurs.

order.complete

Defines a completed order

This occurs whenever a fulfiller fulfills the order in full, and the charge is captured in full. Or fulfiller fulfills the order in part and cancels the remainder of the order, and the charge is captured in part. In both instances, the event marks the order charge as complete.

order.created Defines a new order

This occurs whenever an order may be pending funds and may be pending fraud.

order.fulfilled Defines a fulfilled order

This occurs whenever the fulfiller fulfills an order in full or fulfills the order in part and cancels the remainder of the order.

order.in_review

Defines an order in review

This occurs whenever the order is in review.

order.passed

Defines an order passed fraud

This occurs whenever an order passed fraud.

order.refunded Defines a refunded order

This occurs whenever an order is refunded in part or full.

order.returned

Defines a returned order

This occurs whenever a customer returns an order in full, or returns an order in part and cancels the remainder of the order.

order.review_closed Defines a closed review for an order

This occurs whenever an order passes fraud or DPL review.

order.review_opened Defines an open review for an order

This occurs whenever an order enters fraud or DPL review.

order.submitted

Defines a submitted order

This occurs whenever an order is not pending funds but may be pending fraud.

Refund events

Event

Description

refund.complete Defines a new refund

This occurs whenever the refund is complete.

refund.created Defines a new refund

This occurs whenever a refund is created for all or part of an order.

refund.failed Defines a failed refund

This occurs whenever an order refund fails.

refund.pending_information Defines refund state updated to pending information

This occurs whenever the refund state updates to pending information for a delayed payment method (such as Wire Transfer and bPay).

refund.updated Defines an updated refund

This occurs whenever the metadata for a refund is updated.

refund.succeeded Defines an updated refund

This occurs whenever a refund occurs for all or part of an order.

Return events

Event

Description

return.accepted Defines an accepted return

This occurs whenever a return is accepted (all of the items defined in the return).

return.created Defines a new return

This occurs whenever a return is created, including partial returns.

return.not_accepted Defines a rejected return

This occurs whenever a return is rejected (including partial return rejections).

return.updated Defines an updated return

This occurs whenever the metadata for a return is updated.

Sales Transaction events

Event

Description

sales_transaction.created

Defines a new sales transaction

This occurs whenever a costed sales transaction is created.

SKU events

Event

Description

sku.created Defines a new SKU

This occurs whenever a SKU is created.

sku.deleted Defines a deleted SK

This occurs whenever a SKU is deleted.

sku.updated Defines an updated SKU

This occurs whenever a SKU is updated.

Source events

Event

Description

source.chargeable Defines a chargeable source

This occurs whenever a source is chargeable.

source.created Defines a new source

This occurs whenever a new source is created.