Create a test accountSign in to DashboardSystem status
Search…
⌃K
Links

Key event types

Understand the key event types that your integration might want to monitor
In the Digital River APIs, there are hundreds of types of events. Most integrations however only need to configure webhooks for a small number of them.
For details on how to access a complete list of available event types, refer to Webhooks in Dashboard.
On this page, you'll find example payloads for:
Keep in mind 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 contain 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 more details, refer to the order accepted event section on the Processing orders page.
order.accepted
{
"id": "e5bf7399-49ba-4ea6-a217-65e8efcaee86",
"type": "order.accepted",
"data": {
"object": {
"id": "204440790336",
"createdTime": "2021-11-01T18:23:02Z",
"customerId": "550103150336",
"currency": "USD",
"email": "[email protected]",
"shipTo": {
"address": {
"line1": "1234 Any Road W",
"city": "Minneapolis",
"postalCode": "55401",
"state": "MN",
"country": "US"
},
"name": "Chase Marshall"
},
"shipFrom": {
"address": {
"country": "US"
}
},
"billTo": {
"address": {
"line1": "Any other road W",
"city": "Eagan",
"postalCode": "55122",
"state": "MN",
"country": "US"
},
"name": "Chase Marshall",
"email": "[email protected]"
},
"totalAmount": 27.01,
"subtotal": 25.0,
"totalFees": 0.0,
"totalTax": 2.01,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 5.0,
"items": [
{
"id": "127911830336",
"skuId": "ed7b06bd-7b2e-4525-9156-cd6fcbe7fe42",
"productDetails": {
"id": "ed7b06bd-7b2e-4525-9156-cd6fcbe7fe42",
"name": "Widget",
"description": "A small gadget or mechanical device",
"countryOfOrigin": "US",
"weight": 10,
"weightUnit": "g",
"partNumber": "eecf60da-b082-47eb-9a3f-602820f22ed9"
},
"amount": 20.0,
"quantity": 2,
"state": "created",
"stateTransitions": {
"created": "2021-11-01T18:23:02Z"
},
"tax": {
"rate": 0.08025,
"amount": 1.61
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"availableToRefundAmount": 0.0,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"amount": 5.0,
"description": "standard",
"serviceLevel": "SG",
"taxAmount": 0.4
},
"updatedTime": "2021-11-01T18:23:02Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"charges": [
{
"id": "f38ea46b-f08e-4465-97ec-3aacd7e83ae6",
"createdTime": "2021-11-01T18:23:00Z",
"currency": "USD",
"amount": 27.01,
"state": "capturable",
"captured": false,
"refunded": false,
"sourceId": "4e1f0dfc-471c-4918-b541-66d29879b201",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "4e1f0dfc-471c-4918-b541-66d29879b201",
"type": "creditCard",
"amount": 27.01,
"owner": {
"firstName": "Chase",
"lastName": "Marshall",
"email": "[email protected]",
"address": {
"line1": "Any other road W",
"city": "Eagan",
"postalCode": "55122",
"state": "MN",
"country": "US"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "d68bcfbe-c502-4f3d-abaa-0e3784b68e94",
"amountContributed": 27.01,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "d68bcfbe-c502-4f3d-abaa-0e3784b68e94_8b63972f-5eb2-49cb-ad55-3fa768fc96f1"
}
},
"state": "accepted",
"stateTransitions": {
"accepted": "2021-11-01T18:23:05Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"passed": "2021-11-01T18:23:05Z"
},
"requestToBeForgotten": false,
"capturedAmount": 0.0,
"cancelledAmount": 0.0,
"availableToRefundAmount": 0.0,
"checkoutId": "0ef63391-ba3e-4c9d-9eb7-4f00cd2c3a39"
}
},
"liveMode": false,
"createdTime": "2021-11-01T18:23:06.272054Z",
"webhookIds": [
"498f81d7-988e-45ad-9d06-9577f51de5ea",
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb"
],
"digitalriverVersion": "2021-03-23"
}

order.review_opened

For more details, refer to the in-process fraud review event section on the Processing orders page.
order.review_opened
{
"id": "8a0b8ab1-930d-44bd-9d31-e5c94640cd88",
"type": "order.review_opened",
"data": {
"object": {
"id": "200529590336",
"createdTime": "2021-09-28T13:26:37Z",
"currency": "USD",
"email": "[email protected]",
"shipTo": {
"address": {
"line1": "122 Backwater Street",
"line2": "Suite 116",
"city": "Montreal",
"postalCode": "H3H2P2",
"state": "QC",
"country": "CA"
},
"name": "Carmen Sandiego"
},
"shipFrom": {
"address": {
"country": "US"
}
},
"billTo": {
"address": {
"line1": "122 Backwater Street",
"line2": "Suite 116",
"city": "Montreal",
"postalCode": "H3H2P2",
"state": "QC",
"country": "CA"
},
"name": "Carmen Sandiego",
"email": "[email protected]"
},
"totalAmount": 28.75,
"subtotal": 25.0,
"totalFees": 0.0,
"totalTax": 3.75,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 5.0,
"items": [
{
"id": "123247990336",
"skuId": "c511793f-067a-4fa2-9980-d2c853b052ef",
"productDetails": {
"id": "c511793f-067a-4fa2-9980-d2c853b052ef",
"name": "Widget",
"description": "A small gadget or mechanical device",
"countryOfOrigin": "US",
"weight": 10,
"weightUnit": "g",
"partNumber": "eecf60da-b082-47eb-9a3f-602820f22ed9"
},
"amount": 20.0,
"quantity": 2,
"state": "created",
"stateTransitions": {
"created": "2021-09-28T13:26:38Z"
},
"tax": {
"rate": 0.14975,
"amount": 3.0
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"availableToRefundAmount": 0.0,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"amount": 5.0,
"description": "standard",
"serviceLevel": "SG",
"taxAmount": 0.75
},
"updatedTime": "2021-09-28T13:26:37Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"charges": [
{
"id": "3935e685-cb66-412b-82d7-32083de1dd2c",
"createdTime": "2021-09-28T13:26:40Z",
"currency": "USD",
"amount": 28.75,
"state": "capturable",
"captured": false,
"refunded": false,
"sourceId": "55030c51-20e0-4880-82c7-bc69f1881087",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "55030c51-20e0-4880-82c7-bc69f1881087",
"type": "creditCard",
"amount": 28.75,
"owner": {
"firstName": "Carmen",
"lastName": " Sandiego",
"email": "[email protected]",
"address": {
"line1": "122 Backwater Street",
"line2": "Suite 116",
"city": "Montreal",
"postalCode": "H3H2P2",
"state": "QC",
"country": "CA"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "187dcbd4-5aef-4a0e-b19c-63d6ab586b9e",
"amountContributed": 28.75,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "187dcbd4-5aef-4a0e-b19c-63d6ab586b9e_c216d490-9f01-4f8f-8249-fefc16c2d93a"
}
},
"state": "in_review",
"stateTransitions": {
"in_review": "2021-09-28T13:26:41Z"
},
"fraudState": "review_opened",
"fraudStateTransitions": {
"review_opened": "2021-09-28T13:26:41Z"
},
"requestToBeForgotten": false,
"capturedAmount": 0.0,
"cancelledAmount": 0.0,
"availableToRefundAmount": 0.0,
"checkoutId": "b8ec873d-6764-44ad-b159-176c8e9dca51"
}
},
"liveMode": false,
"createdTime": "2021-09-28T13:26:41.790409Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb",
"8044a862-e7c9-4a8f-a3bb-b6b987a2be9e"
],
"digitalriverVersion": "2021-03-23"
}

order.pending_payment

For more details, refer to the pending charge authorization event section on the Processing orders page.
order.pending_payment
{
"id": "04aca33a-92da-421e-aad2-05276e175cff",
"type": "order.pending_payment",
"data": {
"object": {
"id": "204415340336",
"createdTime": "2021-11-01T11:52:50Z",
"currency": "USD",
"email": "[email protected]",
"shipTo": {
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "William Brown",
"phone": "763-397-8956",
"email": "[email protected]"
},
"shipFrom": {
"address": {
"line1": "Kornmarken 35",
"line2": "line2",
"city": "Billund",
"postalCode": "100091",
"country": "US"
}
},
"billTo": {
"address": {
"line1": "1234 Fake St.",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "William Brown",
"phone": "763-397-8956",
"email": "[email protected]"
},
"totalAmount": 27.16,
"subtotal": 25.25,
"totalFees": 0.0,
"totalTax": 1.91,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 0.2,
"items": [
{
"id": "127883440336",
"skuId": "1879af73-49c3-495c-8a67-68e8c2e1ba9b",
"productDetails": {
"id": "1879af73-49c3-495c-8a67-68e8c2e1ba9b",
"name": "Widget",
"description": "A small gadget or mechanical device",
"countryOfOrigin": "US",
"weight": 10,
"weightUnit": "g",
"partNumber": "eecf60da-b082-47eb-9a3f-602820f22ed9"
},
"amount": 25.05,
"quantity": 5,
"state": "created",
"stateTransitions": {
"created": "2021-11-01T11:52:51Z"
},
"tax": {
"rate": 0.07525,
"amount": 1.89
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"subscriptionInfo": {
"subscriptionId": "11111111",
"terms": "The buyer agrees to pay money in exchange for goods or services",
"autoRenewal": true,
"freeTrial": false,
"billingAgreementId": "850828b5-bee0-4759-aadd-ff791ca47915"
},
"availableToRefundAmount": 0.0,
"shipFrom": {
"address": {
"line1": "Kornmarken 35",
"line2": "line2",
"city": "Billund",
"postalCode": "100091",
"country": "DE"
}
},
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"amount": 0.2,
"description": "Client provides-Standard Ground - US",
"serviceLevel": "Client provides shipping service",
"taxAmount": 0.02
},
"metadata": {
"testingtype": "end-to-end4",
"producttype": "digital"
},
"updatedTime": "2021-11-01T11:52:50Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"sources": [
{
"id": "82737a88-d02d-4912-8808-304ab62d482b",
"type": "wireTransfer",
"amount": 27.16,
"owner": {
"firstName": "William",
"lastName": "Brown",
"email": "[email protected]",
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
}
},
"wireTransfer": {
"accountHolder": "Global Collect BV",
"bankName": "Rabobank N.A.",
"city": "Ontario",
"country": "IN",
"referenceId": "890701505439",
"accountNumber": "0487369908",
"swiftCode": "RABOUS66XXX"
}
}
],
"session": {
"id": "a626ef66-91c5-48eb-881f-1d09a2b11545",
"amountContributed": 27.16,
"amountRemainingToBeContributed": 0.0,
"state": "pending_funds",
"clientSecret": "a626ef66-91c5-48eb-881f-1d09a2b11545_88a3e722-4544-4514-8021-09ddbb1d8a3a"
}
},
"state": "pending_payment",
"stateTransitions": {
"pending_payment": "2021-11-01T11:52:53Z"
},
"requestToBeForgotten": false,
"capturedAmount": 0.0,
"cancelledAmount": 0.0,
"availableToRefundAmount": 0.0,
"checkoutId": "05a95907-d8d2-4628-84a5-02e4302b7019"
}
},
"liveMode": false,
"createdTime": "2021-11-01T11:52:53.606272Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb",
"8044a862-e7c9-4a8f-a3bb-b6b987a2be9e",
"9666a0f9-d2a5-4eba-8b56-ecf7e87bb84c"
],
"digitalriverVersion": "2021-03-23"
}

order.blocked

For more details, refer to the fraud block event section on the Processing orders page.
order.blocked
{
"id": "28f91ddb-b93b-401e-9fa0-19c9c8e3140e",
"type": "order.blocked",
"data": {
"object": {
"id": "200528060336",
"createdTime": "2021-09-28T13:21:39Z",
"currency": "USD",
"email": "[email protected]",
"shipTo": {
"address": {
"line1": "10380 Bren Road W",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "John Doe"
},
"shipFrom": {
"address": {
"country": "US"
}
},
"billTo": {
"address": {
"line1": "122 Backwater Street",
"line2": "Suite 116",
"city": "Montreal",
"postalCode": "H3H2P2",
"state": "QC",
"country": "CA"
}
"name": "Carmen Sandiego",
"email": "[email protected]"
},
"totalAmount": 26.89,
"subtotal": 25.0,
"totalFees": 0.0,
"totalTax": 1.89,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 5.0,
"items": [
{
"id": "123248430336",
"skuId": "c511793f-067a-4fa2-9980-d2c853b052ef",
"productDetails": {
"id": "c511793f-067a-4fa2-9980-d2c853b052ef",
"name": "Widget",
"description": "A small gadget or mechanical device",
"countryOfOrigin": "US",
"weight": 10,
"weightUnit": "g",
"partNumber": "eecf60da-b082-47eb-9a3f-602820f22ed9"
},
"amount": 20.0,
"quantity": 2,
"state": "blocked",
"stateTransitions": {
"blocked": "2021-09-28T19:33:50Z",
"created": "2021-09-28T13:21:40Z"
},
"tax": {
"rate": 0.07525,
"amount": 1.51
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"amount": 5.0,
"description": "standard",
"serviceLevel": "SG",
"taxAmount": 0.38
},
"updatedTime": "2021-09-28T19:33:50Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"charges": [
{
"id": "56312ef0-7666-47d3-be6d-61b07d0210a0",
"createdTime": "2021-09-28T13:21:41Z",
"currency": "USD",
"amount": 26.89,
"state": "cancelled",
"captured": false,
"refunded": false,
"cancels": [
{
"id": "84462904-e56b-49a6-826c-3eb22ce0ebb0",
"createdTime": "2021-09-28T19:33:49Z",
"amount": 26.89,
"state": "complete"
}
],
"sourceId": "9bdf9185-9e3b-427a-abc3-061a4f31e0c3",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "9bdf9185-9e3b-427a-abc3-061a4f31e0c3",
"type": "creditCard",
"amount": 26.89,
"owner": {
"firstName": "Carmen",
"lastName": "Sandiego",
"email": "[email protected]",
"address": {
"line1": "122 Backwater Street",
"line2": "Suite 116",
"city": "Montreal",
"postalCode": "H3H2P2",
"state": "QC",
"country": "CA"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "d0df15ef-a1cd-426d-9bb2-e4621710df64",
"amountContributed": 26.89,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "d0df15ef-a1cd-426d-9bb2-e4621710df64_ca28159d-abce-4159-82c2-cb4caa3fff6e"
}
},
"state": "blocked",
"stateTransitions": {
"in_review": "2021-09-28T13:21:43Z",
"blocked": "2021-09-28T19:33:50Z"
},
"fraudState": "blocked",
"fraudStateTransitions": {
"blocked": "2021-09-28T19:33:50Z",
"review_opened": "2021-09-28T13:21:43Z"
},
"requestToBeForgotten": false,
"capturedAmount": 0.0,
"cancelledAmount": 0.0,
"availableToRefundAmount": 0.0,
"checkoutId": "71b2cb17-8a3b-4ba2-a17b-b15f3cf8f40f"
}
},
"liveMode": false,
"createdTime": "2021-09-28T19:33:52.343346Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb",
"8044a862-e7c9-4a8f-a3bb-b6b987a2be9e"
],
"digitalriverVersion": "2021-03-23"
}

order.charge.failed

For more details, refer to the charge authorization failure event section on the Processing orders page.

order.cancelled

For more details, refer to the order cancelled event section on the Processing orders page.
order.cancelled
{
"id": "eeb0610a-0018-43fc-8562-4f8d2cae265d",
"type": "order.cancelled",
"data": {
"object": {
"id": "231722950336",
"createdTime": "2022-07-05T15:17:18Z",
"currency": "USD",
"email": "[email protected]",
"billTo": {
"address": {
"line1": "123 Main Street",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "John SourceFailWithDelay",
"phone": "1555000000",
"email": "[email protected]"
},
"totalAmount": 10.75,
"subtotal": 10.0,
"totalFees": 0.0,
"totalTax": 0.75,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 0.0,
"items": [
{