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 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
order.acceptedFor details, refer to the following pages:
Handling an accepted order on the Processing orders page.
{
"id": "e5bf7399-49ba-4ea6-a217-65e8efcaee86",
"type": "order.accepted",
"data": {
"object": {
"id": "204440790336",
"createdTime": "2021-11-01T18:23:02Z",
"customerId": "550103150336",
"currency": "USD",
"email": "chaseMarshall@digitalriver.com",
"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": "marshallsBillingEmail@digitalriver.com"
},
"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": "marshallsBillingEmail@digitalriver.com",
"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
order.review_openedRefer to the in-process fraud review event section on the Processing orders page for details.
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": "anyemail@digitalriver.com",
"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": "null@digitalriver.com"
},
"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": "null@digitalriver.com",
"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
order.pending_paymentRefer to the pending charge authorization event section processing orders pages for details.
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": "test@digitalriver.com",
"shipTo": {
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "William Brown",
"phone": "763-397-8956",
"email": "testmail@digitalriver.com"
},
"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": "testmail@digitalriver.com"
},
"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": "guy@example.org",
"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
order.blockedRefer to the fraud block event section on the Processing orders page for details.
order.blocked
{
"id": "28f91ddb-b93b-401e-9fa0-19c9c8e3140e",
"type": "order.blocked",
"data": {
"object": {
"id": "200528060336",
"createdTime": "2021-09-28T13:21:39Z",
"currency": "USD",
"email": "anyemail@digitalriver.com",
"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": "null@digitalriver.com"
},
"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": "null@digitalriver.com",
"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
order.charge.failedRefer to the charge authorization failure event section on the Processing orders page for details.
order.cancelled
order.cancelledRefer to the order cancelled event section on the Processing orders page for details.
order.cancelled
{
"id": "eeb0610a-0018-43fc-8562-4f8d2cae265d",
"type": "order.cancelled",
"data": {
"object": {
"id": "231722950336",
"createdTime": "2022-07-05T15:17:18Z",
"currency": "USD",
"email": "null@digitalriver.com",
"billTo": {
"address": {
"line1": "123 Main Street",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "John SourceFailWithDelay",
"phone": "1555000000",
"email": "john.doe@gmail.com"
},
"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": [
{
"id": "158512920336",
"productDetails": {
"id": "PhysicalProductData",
"skuGroupId": "9b225842-86d7-4977-8c3f-de3f88e2e4d0",
"name": "Logitech Keyboard",
"description": "Top rated wireless keyboard",
"url": "https://producturl.com",
"countryOfOrigin": "US",
"image": "https://imageurl.com",
"weight": 20,
"weightUnit": "oz",
"partNumber": "SWG1224J10L"
},
"amount": 10.0,
"quantity": 1,
"state": "cancelled",
"stateTransitions": {
"created": "2022-07-05T15:17:19Z",
"cancelled": "2022-07-05T15:17:51Z"
},
"tax": {
"rate": 0.07525,
"amount": 0.75
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"updatedTime": "2022-07-05T15:17:51Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"sources": [
{
"id": "a1ff68c2-fafd-4d06-9315-f9fb48443d10",
"type": "wireTransfer",
"amount": 10.75,
"owner": {
"firstName": "John",
"lastName": "SourceFailWithDelay",
"email": "john.doe@gmail.com",
"address": {
"line1": "123 Main Street",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
}
},
"wireTransfer": {
"accountHolder": "Global Collect BV",
"bankName": "Rabobank N.A.",
"city": "Ontario",
"country": "US",
"referenceId": "890701505439",
"accountNumber": "0487369908",
"swiftCode": "RABOUS66XXX"
}
}
],
"session": {
"id": "ba5be14b-8b8d-4ce9-ab2c-f65cca90c997",
"amountContributed": 10.75,
"amountRemainingToBeContributed": 0.0,
"state": "failed",
"clientSecret": "ba5be14b-8b8d-4ce9-ab2c-f65cca90c997_7774c378-0d3a-45da-a42a-eb804fb32f15",
"nextAction": {
"action": "show_payment_instructions",
"data": {
"sourceId": "a1ff68c2-fafd-4d06-9315-f9fb48443d10",
"sourceClientSecret": "a1ff68c2-fafd-4d06-9315-f9fb48443d10_aae20c42-4988-4148-a1a4-2182df4cfc08"
}
}
}
},
"state": "cancelled",
"stateTransitions": {
"cancelled": "2022-07-05T15:17:51Z",
"pending_payment": "2022-07-05T15:17:21Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"passed": "2022-07-05T15:17:51Z"
},
"requestToBeForgotten": false,
"capturedAmount": 0.0,
"cancelledAmount": 0.0,
"availableToRefundAmount": 0.0,
"checkoutId": "f59e697e-1819-4df8-bf69-2a9aac90972b"
}
},
"liveMode": false,
"createdTime": "2022-07-05T15:17:54.384046Z",
"webhookIds": [
"9666a0f9-d2a5-4eba-8b56-ecf7e87bb84c",
"f666c369-b0bb-4412-a5ca-bf37bef3b982"
],
"digitalriverVersion": "2021-12-13"
}fulfillment.created
fulfillment.createdRefer to the fulfillment created event section on the Capturing and cancelling payment charges page for details.
fulfillment.created
{
"id": "6e4f29fd-190e-4a70-83dc-6655394dc054",
"type": "fulfillment.created",
"data": {
"object": {
"id": "ful_e3624f2e-1260-4cb1-bf5e-077e1e9c215e",
"createdTime": "2023-03-28T18:23:52Z",
"items": [
{
"quantity": 1,
"cancelQuantity": 0,
"skuId": "657cdceb-707e-48c4-8bb6-b1e458052dc8",
"itemId": "189752780336"
},
{
"quantity": 1,
"cancelQuantity": 0,
"skuId": "ba4c5621-9704-412f-9365-a584e3d3d61f",
"itemId": "189752790336"
}
],
"orderId": "259855820336",
"trackingCompany": "Fedex",
"trackingNumber": "Z10100002632653",
"trackingUrl": "http://www.fedex.com/Tracking?tracknumbers=Z10100002632653",
"liveMode": false,
"orderDetails": {
"id": "259855820336",
"createdTime": "2023-03-28T18:23:29Z",
"currency": "USD",
"email": "d@digitalriver.com",
"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": "Hilda Brandt",
"email": "marshallsBillingEmail@digitalriver.com"
},
"totalAmount": 47.01,
"subtotal": 45.0,
"totalFees": 0.0,
"totalTax": 2.01,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 5.0,
"items": [
{
"id": "189752780336",
"skuId": "657cdceb-707e-48c4-8bb6-b1e458052dc8",
"productDetails": {
"id": "657cdceb-707e-48c4-8bb6-b1e458052dc8",
"name": "Dog biscuits",
"countryOfOrigin": "US",
"image": "https://upload.wikimedia.org/wikipedia/commons/6/6e/Golde33443.jpg",
"partNumber": "657cdceb-707e-48c4-8bb6-b1e458052dc8"
},
"amount": 20.0,
"quantity": 2,
"state": "created",
"stateTransitions": {
"created": "2023-03-28T18:23:30Z"
},
"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
},
"shipping": {
"amount": 5.0,
"taxAmount": 0.4
}
},
{
"id": "189752790336",
"skuId": "ba4c5621-9704-412f-9365-a584e3d3d61f",
"productDetails": {
"id": "ba4c5621-9704-412f-9365-a584e3d3d61f",
"name": "Digital Product",
"description": "A small mechanical device",
"countryOfOrigin": "US",
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/6/6e/Golde33443.jpg/640px-Golde33443.jpg",
"partNumber": "ba4c5621-9704-412f-9365-a584e3d3d61f"
},
"amount": 20.0,
"quantity": 2,
"state": "created",
"stateTransitions": {
"created": "2023-03-28T18:23:30Z"
},
"tax": {
"rate": 0.0,
"amount": 0.0
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"availableToRefundAmount": 0.0,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
},
"shipping": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"id": "123",
"amount": 5.0,
"description": "standard",
"serviceLevel": "SG",
"taxAmount": 0.4,
"shippingTerms": "DDP"
},
"updatedTime": "2023-03-28T18:23:29Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "DR_INC-ENTITY",
"name": "Digital River Inc."
},
"liveMode": false,
"state": "accepted",
"stateTransitions": {
"accepted": "2023-03-28T18:23:33Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"passed": "2023-03-28T18:23:33Z"
},
"requestToBeForgotten": false,
"capturedAmount": 0.0,
"cancelledAmount": 0.0,
"availableToRefundAmount": 0.0,
"checkoutId": "29a9cc77-7b63-43d7-9a49-8eb44d0cc6fc"
}
}
},
"liveMode": false,
"createdTime": "2023-03-28T18:23:52.939306Z",
"digitalriverVersion": "2021-12-13"
}order.fulfilled
order.fulfilledRefer to the order fulfilled event section on the Capturing and cancelling payment charges page for details.
{
"id": "64ef274c-fd5b-4c69-b862-6ff86cf711ff",
"type": "order.fulfilled",
"data": {
"object": {
"id": "231714050336",
"createdTime": "2022-07-05T13:00:16Z",
"customerId": "e9958aed-271d-4bb5-8f1c-ec1c95f94771",
"currency": "USD",
"email": "jsmith@digitalriver.com",
"shipTo": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "string",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "John Smith",
"phone": "952-111-1111",
"email": "jsmith@digitalriver.com",
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "New div",
"phoneticName": "new name"
}
},
"billTo": {
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "Digital Development",
"email": "testdummy@digitalriver.com",
"organization": "DR",
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"totalAmount": 32.21,
"subtotal": 30.0,
"totalFees": 0.0,
"totalTax": 2.21,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 0.0,
"items": [
{
"id": "158504960336",
"skuId": "4bc91f2e-3f9e-4357-bf30-522d5179600b",
"productDetails": {
"id": "4bc91f2e-3f9e-4357-bf30-522d5179600b",
"name": "Athena Womens Running Shoes 3f4216e8-0eb1-4c0f-ba31-c657522b8848",
"countryOfOrigin": "US"
},
"amount": 30.0,
"quantity": 2,
"metadata": {
"key3": "value3",
"key4": "value4"
},
"state": "fulfilled",
"stateTransitions": {
"created": "2022-07-05T13:00:17Z",
"fulfilled": "2022-07-05T13:00:24Z"
},
"tax": {
"rate": 0.07375,
"amount": 2.21
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"subscriptionInfo": {
"subscriptionId": "invoice-test-2020-03-20",
"terms": "Please accept terms",
"autoRenewal": true,
"freeTrial": false,
"billingAgreementId": "89011a82-621f-448b-a691-a3bf39b650fe"
},
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"updatedTime": "2022-07-05T13:00:24Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"charges": [
{
"id": "3ecf8b83-2e61-4bd1-81f6-b286aa1afb33",
"createdTime": "2022-07-05T13:00:21Z",
"currency": "USD",
"amount": 32.21,
"state": "processing",
"captured": true,
"captures": [
{
"id": "096a3218-7f23-4838-a6e0-aba0f6a7708f",
"createdTime": "2022-07-05T13:00:24Z",
"amount": 32.21,
"state": "pending"
}
],
"refunded": false,
"sourceId": "a1eefd90-04f3-40c6-989b-945b1066cc28",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "a1eefd90-04f3-40c6-989b-945b1066cc28",
"type": "creditCard",
"amount": 32.21,
"owner": {
"firstName": "Digital",
"lastName": "Development",
"email": "testdummy@digitalriver.com",
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"organization": "DR",
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "f871a7aa-d6a6-408e-90ff-6fa9fd304fa1",
"amountContributed": 32.21,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "f871a7aa-d6a6-408e-90ff-6fa9fd304fa1_76145dbe-218e-4c8e-b6f6-824f3971d15a"
}
},
"state": "fulfilled",
"stateTransitions": {
"fulfilled": "2022-07-05T13:00:24Z",
"accepted": "2022-07-05T13:00:22Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"passed": "2022-07-05T13:00:22Z"
},
"requestToBeForgotten": false,
"capturedAmount": 32.21,
"cancelledAmount": 0.0,
"availableToRefundAmount": 0.0,
"checkoutId": "82380fbc-59d8-4644-b7f2-f53a3f52384a"
}
},
"liveMode": false,
"createdTime": "2022-07-05T13:00:26.67313Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb",
"79cb5206-4cd9-40c3-836a-8a5e0e822c18",
"8044a862-e7c9-4a8f-a3bb-b6b987a2be9e",
"9666a0f9-d2a5-4eba-8b56-ecf7e87bb84c",
"f666c369-b0bb-4412-a5ca-bf37bef3b982"
],
"digitalriverVersion": "2021-12-13"
}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.completeee
{
"id": "f275be0a-45fd-4160-8a31-b3274b6a4f8b",
"type": "order.charge.capture.complete",
"data": {
"object": {
"id": "b67136cc-0b2e-43f7-8d9a-362047aa975a",
"createdTime": "2022-03-02T16:50:23Z",
"currency": "USD",
"amount": 37.81,
"state": "capturable",
"orderId": "218377480336",
"captured": true,
"captures": [
{
"id": "b496b7b2-3bc7-49cd-ab48-f91b2f2e37cc",
"createdTime": "2022-03-02T16:50:37Z",
"amount": 25.21,
"state": "complete",
"fulfillmentId": "ful_a0246997-bdcf-480a-a066-2cfc564e6232"
}
],
"refunded": false,
"sourceId": "52ca4456-5547-4f9c-8016-1a067fd0b125",
"paymentSessionId": "7c121712-2ae8-4617-97a2-5d41fd79a5b8",
"type": "customer_initiated",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2022-03-02T16:52:01.180061Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb",
"8044a862-e7c9-4a8f-a3bb-b6b987a2be9e",
"9666a0f9-d2a5-4eba-8b56-ecf7e87bb84c",
"f666c369-b0bb-4412-a5ca-bf37bef3b982"
],
"digitalriverVersion": "2021-12-13"
}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.capture.failed
{
"id": "e6433f08-b500-4a07-825f-e5785bb27a7e",
"type": "order.charge.capture.failed",
"data": {
"object": {
"id": "c5da98d9-bb05-4e4d-b0c1-75dfbd1303e8",
"createdTime": "2021-11-01T17:55:53Z",
"currency": "USD",
"amount": 20.0,
"state": "capturable",
"orderId": "204439700336",
"captured": true,
"captures": [
{
"id": "a682d7f5-7da8-4544-8917-83c2407b36f1",
"createdTime": "2021-11-01T17:56:22Z",
"amount": 10.0,
"state": "failed",
"failureCode": "failed-request"
}
],
"refunded": false,
"sourceId": "2c38109f-29e6-4266-b50b-05d46191828b",
"paymentSessionId": "687b4ddd-36f1-4ee4-8196-f2299ce3121e",
"type": "customer_initiated",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2021-11-01T17:56:27.619631Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb",
"8044a862-e7c9-4a8f-a3bb-b6b987a2be9e",
"8b280dda-645f-48dc-bb0c-03e7bcb72c04",
"9666a0f9-d2a5-4eba-8b56-ecf7e87bb84c"
],
"digitalriverVersion": "2021-03-23"
}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.charge.cancel.complete
{
"id": "3a381317-cf50-49c1-8d37-18ad81551493",
"type": "order.charge.cancel.complete",
"data": {
"object": {
"id": "e31e1d24-97cc-4ad3-8d26-0f10c1a2c99b",
"createdTime": "2021-11-01T17:51:45Z",
"currency": "USD",
"amount": 20.0,
"state": "capturable",
"orderId": "204440200336",
"captured": false,
"refunded": false,
"cancels": [
{
"id": "0eea1eec-25e1-4030-bc3b-7368f5d8c0b7",
"createdTime": "2021-11-01T17:52:03Z",
"amount": 10.0,
"state": "complete"
}
],
"sourceId": "2f8f56d0-f8b7-48b7-990b-dcfc7d989988",
"paymentSessionId": "9ef14398-ecf3-4b31-b881-958d32292afa",
"type": "customer_initiated",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2021-11-01T17:52:08.257048Z",
"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.complete
order.completeFor details, refer to the order complete event section on the Capturing and cancelling payment charges page.
order.complete
{
"id": "fc981ba4-0f56-440c-af99-9e6465ecb1f6",
"type": "order.complete",
"data": {
"object": {
"id": "204440120336",
"createdTime": "2021-11-01T17:46:19Z",
"currency": "USD",
"email": "null@digitalriver.com",
"billTo": {
"address": {
"line1": "10381 Bren Rd W",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "William Brown",
"email": "null@digitalriver.com"
},
"totalAmount": 20.0,
"subtotal": 20.0,
"totalFees": 0.0,
"totalTax": 0.0,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 0.0,
"items": [
{
"id": "127910100336",
"skuId": "fe83ab0a-68a1-405c-8e3e-7773603e6c9c",
"productDetails": {
"id": "fe83ab0a-68a1-405c-8e3e-7773603e6c9c",
"name": "Widget",
"description": "A small gadget or mechanical device",
"countryOfOrigin": "US",
"weight": 10,
"weightUnit": "g",
"partNumber": "eecf60da-b082-47eb-9a3f-602820f22ed9"
},
"amount": 10.0,
"quantity": 1,
"state": "fulfilled",
"stateTransitions": {
"created": "2021-11-01T17:46:20Z",
"fulfilled": "2021-11-01T17:46:38Z"
},
"tax": {
"rate": 0.0,
"amount": 0.0
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"availableToRefundAmount": 10.0,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
},
{
"id": "127910110336",
"skuId": "fe83ab0a-68a1-405c-8e3e-7773603e6c9c",
"amount": 10.0,
"quantity": 1,
"state": "fulfilled",
"stateTransitions": {
"created": "2021-11-01T17:46:20Z",
"fulfilled": "2021-11-01T17:48:31Z"
},
"tax": {
"rate": 0.0,
"amount": 0.0
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"availableToRefundAmount": 10.0,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"updatedTime": "2021-11-01T17:49:06Z",
"browserIp": "192.0.2.165",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"charges": [
{
"id": "a77c83ae-2a55-4a29-9e84-18de3d500ae8",
"createdTime": "2021-11-01T17:46:20Z",
"currency": "USD",
"amount": 20.0,
"state": "complete",
"captured": true,
"captures": [
{
"id": "16380607-128e-4b07-ac3c-bd176a80d287",
"createdTime": "2021-11-01T17:46:32Z",
"amount": 10.0,
"state": "complete"
},
{
"id": "b87ff447-dc2a-43e0-b93b-0174ecf59730",
"createdTime": "2021-11-01T17:48:24Z",
"amount": 10.0,
"state": "complete"
}
],
"refunded": false,
"sourceId": "0225786d-1c1a-48fe-b4cb-ffb47a9cabe3",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "0225786d-1c1a-48fe-b4cb-ffb47a9cabe3",
"type": "creditCard",
"amount": 20.0,
"owner": {
"firstName": "William",
"lastName": "Brown",
"email": "null@digitalriver.com",
"address": {
"line1": "10381 Bren Rd W",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "f96602ed-660a-4553-9b4e-2b7ad1db8155",
"amountContributed": 20.0,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "f96602ed-660a-4553-9b4e-2b7ad1db8155_b431ee59-36b6-4143-a538-a7ac6b613b52"
}
},
"state": "complete",
"stateTransitions": {
"fulfilled": "2021-11-01T17:48:31Z",
"accepted": "2021-11-01T17:46:26Z",
"complete": "2021-11-01T17:49:06Z"
},
"fraudStateTransitions": {
"passed": "2021-11-01T17:46:26Z"
},
"requestToBeForgotten": false,
"capturedAmount": 20.0,
"cancelledAmount": 0.0,
"availableToRefundAmount": 20.0,
"checkoutId": "109f3d00-04f9-4e9c-8877-1b7fdf384711"
}
},
"liveMode": false,
"createdTime": "2021-11-01T17:49:09.821659Z",
"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.invoice.created
order.invoice.createdRefer to the handling the order invoice created event section on the Accessing invoices and credit memos page for details.
order.invoice.created
{
"id": "c902f8aa-16fb-44ba-ba7b-f3c84061685a",
"type": "order.invoice.created",
"data": {
"object": {
"id": "6e5bf525-3907-40c5-86a9-f14ce4f33f35",
"fileId": "6e5bf525-3907-40c5-86a9-f14ce4f33f35",
"orderId": "188418250336",
"customerId": "532736320336",
"purpose": "customer_invoice",
"invoiceURL": "https://api.digitalriver.com/files/6e5bf525-3907-40c5-86a9-f14ce4f33f35/content"
}
},
"liveMode": false,
"createdTime": "2021-04-28T02:04:13.591115Z",
"versionIds": []
}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.credit_memo.created
{
"id": "d3786b5b-540b-4885-92a4-62f937d13f26",
"type": "order.credit_memo.created",
"data": {
"object": {
"id": "c233c10f-17e8-4799-a1ce-2469d042f29d",
"fileId": "c233c10f-17e8-4799-a1ce-2469d042f29d",
"orderId": "188466550336",
"customerId": "532795950336",
"purpose": "customer_credit_memo",
"invoiceURL": "https://api.digitalriver.com/files/c233c10f-17e8-4799-a1ce-2469d042f29d/content"
}
},
"liveMode": false,
"createdTime": "2021-04-29T02:15:20.516626Z",
"versionIds": []
}order.refunded
order.refundedFor details, refer to Completed refunds on the Issuing refunds page.
{
"id": "039093b3-09ed-4837-8886-940581d2462c",
"type": "order.refunded",
"data": {
"object": {
"id": "235504220336",
"createdTime": "2022-08-08T14:46:28Z",
"currency": "USD",
"email": "chaseMarshall@digitalriver.com",
"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": "123 Elm St W",
"city": "Minneapolis",
"postalCode": "55101",
"state": "MN",
"country": "US"
},
"name": "Chase Marshall",
"email": "marshallsBillingEmail@digitalriver.com"
},
"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": "162893300336",
"skuId": "d0496ee4-6f76-46b5-a059-1b194fb4d0e5",
"productDetails": {
"id": "d0496ee4-6f76-46b5-a059-1b194fb4d0e5",
"name": "Test Product",
"countryOfOrigin": "US",
"partNumber": "d0496ee4-6f76-46b5-a059-1b194fb4d0e5"
},
"amount": 20.0,
"quantity": 2,
"state": "fulfilled",
"stateTransitions": {
"created": "2022-08-08T14:46:29Z",
"fulfilled": "2022-08-08T14:46:50Z"
},
"tax": {
"rate": 0.08025,
"amount": 1.61
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"availableToRefundAmount": 0.01,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"id": "123",
"amount": 5.0,
"description": "standard",
"serviceLevel": "SG",
"taxAmount": 0.4,
"shippingTerms": "DDP"
},
"updatedTime": "2022-08-08T15:08:35Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "DR_INC-ENTITY",
"name": "Digital River Inc."
},
"liveMode": false,
"payment": {
"charges": [
{
"id": "7c4d1074-7c22-4e56-ba35-6b0f10cb4226",
"createdTime": "2022-08-08T14:46:36Z",
"currency": "USD",
"amount": 27.01,
"state": "complete",
"captured": true,
"captures": [
{
"id": "721dc1fb-76a2-4b6e-bb0e-ccd90612b4a9",
"createdTime": "2022-08-08T14:46:50Z",
"amount": 27.01,
"state": "complete"
}
],
"refunded": true,
"refunds": [
{
"createdTime": "2022-08-08T15:07:43Z",
"amount": 21.6,
"state": "complete"
}
],
"sourceId": "2845d53f-7082-4712-8030-2d3fc0f3963d",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "2845d53f-7082-4712-8030-2d3fc0f3963d",
"type": "creditCard",
"amount": 27.01,
"owner": {
"firstName": "Chase",
"lastName": "Marshall",
"email": "marshallsBillingEmail@digitalriver.com",
"address": {
"line1": "123 Elm St W",
"city": "Minneapolis",
"postalCode": "55101",
"state": "MN",
"country": "US"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "fd4d10ed-fc98-4180-8c50-cc84b8de7110",
"amountContributed": 27.01,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "fd4d10ed-fc98-4180-8c50-cc84b8de7110_8bd97752-c34a-431d-8a97-048f627dbe56"
}
},
"refundedAmount": 21.6,
"state": "complete",
"stateTransitions": {
"fulfilled": "2022-08-08T14:46:50Z",
"accepted": "2022-08-08T14:46:37Z",
"complete": "2022-08-08T14:47:45Z"
},
"fraudStateTransitions": {
"passed": "2022-08-08T14:46:37Z"
},
"requestToBeForgotten": false,
"capturedAmount": 27.01,
"cancelledAmount": 0.0,
"availableToRefundAmount": 5.41,
"invoicePDFs": [
{
"id": "3f9f15a9-72af-497e-b5b5-c6d2e5bedf43",
"url": "https://api.digitalriver.com/files/3f9f15a9-72af-497e-b5b5-c6d2e5bedf43/content",
"liveMode": false
}
],
"checkoutId": "8f0d0a64-1c58-49b3-9afd-08809fb49876"
}
},
"liveMode": false,
"createdTime": "2022-08-08T15:08:42.478434Z",
"digitalriverVersion": "2021-12-13"
}Jsrefund.pending
refund.pendingRefer to the pending refunds section on the Issuing refunds page for details.
refund.pending
{
"id": "07b04605-0089-4789-aRefer
"type": "refund.pending",
"data": {
"object": {
"id": "re_252eb3f4-81b2-4576-aabd-6af2df248e99",
"amount": 13.51,
"createdTime": "2022-03-17T16:17:54Z",
"currency": "USD",
"items": [],
"orderId": "219966860336",
"refundedAmount": 0.0,
"state": "pending",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2022-03-17T16:17:54.93644Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a"
],
"digitalriverVersion": "2021-12-13"
}refund.pending_information
refund.pending_informationRefer to the Refunding asynchronous payment methods page for details.
refund.pending_information
{
"id": "3830d505-f004-4924-b1d5-8c877f164726",
"type": "refund.pending_information",
"data": {
"object": {
"id": "re_d1988e09-eec8-48f4-8077-b6c955c84e69",
"amount": 33.0,
"createdTime": "2022-03-11T20:35:21Z",
"currency": "JPY",
"items": [],
"orderId": "219187180336",
"refundedAmount": 0.0,
"state": "pending_information",
"tokenInformation": {
"token": "17bc3273-b588-420f-bd1f-49a89eec6322",
"expiresTime": "2022-06-09T20:37:21.087Z"
},
"liveMode": false,
"charges": [
{
"id": "5253e76e-e92f-4128-acad-78c26d7999b8",
"captured": true,
"refunded": true,
"refunds": [
{
"createdTime": "2022-03-11T20:37:21Z",
"amount": 33.0,
"state": "pending_information"
}
],
"sourceId": "0e311505-0955-47df-9808-beb34b5a8b30"
}
]
}
},
"liveMode": false,
"createdTime": "2022-03-11T20:37:30.556222Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a"
],
"digitalriverVersion": "2021-12-13"
}refund.complete
refund.completeRefer to the completed refunds section on the Issuing refunds page for details.
refund.complete
{
"id": "ebd5dcb3-7028-4a78-8efb-3d7ca918e96e",
"type": "refund.complete",
"data": {
"object": {
"id": "re_252eb3f4-81b2-4576-aabd-6af2df248e99",
"amount": 13.51,
"createdTime": "2022-03-17T16:17:54Z",
"currency": "USD",
"items": [],
"orderId": "219966860336",
"refundedAmount": 13.51,
"state": "succeeded",
"liveMode": false,
"charges": [
{
"id": "b46e2189-fd69-4819-a886-f43c89283bda",
"captured": true,
"refunded": true,
"refunds": [
{
"createdTime": "2022-03-17T16:22:14Z",
"amount": 13.51,
"state": "complete"
}
],
"sourceId": "cca536f3-93ed-40e8-bd79-99a3dcf2edf8"
}
]
}
},
"liveMode": false,
"createdTime": "2022-03-17T16:23:29.233283Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a"
],
"digitalriverVersion": "2021-12-13"
}refund.failed
refund.failedRefer to the failed refunds section on the Issuing refunds page for details.
refund.failed
{
"id": "73f6350d-bd03-48fc-a1a4-080dc538002a",
"type": "refund.failed",
"data": {
"object": {
"id": "re_9ed7d5b1-186c-492f-bcb1-a4177d9ceead",
"amount": 27.01,
"createdTime": "2022-03-18T13:18:40Z",
"currency": "USD",
"items": [],
"orderId": "220072430336",
"refundedAmount": 0.0,
"state": "failed",
"liveMode": false,
"charges": [
{
"id": "5bb706f7-fb2d-4b02-906e-f8fb4f10d34a",
"captured": true,
"refunded": true,
"refunds": [
{
"createdTime": "2022-03-18T13:22:36Z",
"amount": 27.01,
"state": "failed"
}
],
"sourceId": "824f65eb-2270-402f-9dee-1346db324070"
}
]
}
},
"liveMode": false,
"createdTime": "2022-03-18T13:23:33.253931Z",
"webhookIds": [
"bbac1929-580c-4629-b648-4c096b1a104a",
"6d7055fc-b3b6-42fb-97a8-2443386199fb",
"8044a862-e7c9-4a8f-a3bb-b6b987a2be9e",
"9666a0f9-d2a5-4eba-8b56-ecf7e87bb84c",
"f666c369-b0bb-4412-a5ca-bf37bef3b982"
],
"digitalriverVersion": "2021-12-13"
}jaorder.charge.refund.complete
order.charge.refund.completeorder.charge.refund.complete
{
"id": "f524cae0-2527-4902-b1ff-33250329aa6b",
"type": "order.charge.refund.complete",
"data": {
"object": {
"id": "a9ee46e8-0598-4816-8784-e48a1c1a107e",
"createdTime": "2021-10-31T02:27:53Z",
"currency": "USD",
"amount": 12.36,
"state": "processing",
"orderId": "204289570336",
"captured": true,
"captures": [
{
"id": "267d7410-f3f1-4c66-a2fb-5b1fe2c4cfd1",
"createdTime": "2021-10-31T02:28:02Z",
"amount": 12.36,
"state": "pending"
}
],
"refunded": true,
"refunds": [
{
"id": "ff5e1e6c-955e-416b-8bf1-0b0439a24ce1",
"createdTime": "2021-10-31T02:33:34Z",
"amount": 5.38,
"state": "complete"
}
],
"sourceId": "f7841b57-0d9b-403b-93f4-b2ba33a0047b",
"paymentSessionId": "78270278-6a12-49b0-baca-3a6ccd1f7077",
"type": "customer_initiated",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2021-10-31T02:34:02.543639Z",
"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.charge.refund.failed
order.charge.refund.failedorder.charge.refund.failed
{
"id": "8f5b22da-b5f3-475f-89dd-589d7030e05e",
"type": "order.charge.refund.failed",
"data": {
"object": {
"id": "183238120336",
"createdTime": "2021-01-07T01:02:56Z",
"currency": "USD",
"email": "jsmith123@digitalriver.com",
"shipTo": {
"address": {
"line1": "13806 Bren Road",
"city": "Minnesota",
"postalCode": "60311",
"state": "EMEA",
"country": "NL"
},
"name": "William Brown",
"phone": "763-397-8956",
"email": "wbrown@digitalriver.com"
},
"shipFrom": {
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
}
},
"totalAmount": 27.1,
"subtotal": 27.1,
"totalFees": 0.0,
"totalTax": 0.0,
"totalImporterTax": 4.7,
"importerOfRecordTax": true,
"totalDuty": 2.4,
"totalDiscount": 0.0,
"totalShipping": 10.0,
"items": [
{
"id": "103997850336",
"skuId": "c04eb42a-433c-4d57-8f85-2774b8051753",
"amount": 10.0,
"quantity": 1,
"metadata": {
"Physical_Product": "123456789"
},
"state": "fulfilled",
"stateTransitions": {
"created": "2021-01-07T01:02:56Z",
"fulfilled": "2021-01-07T01:03:17Z"
},
"tax": {
"rate": 0.0,
"amount": 0.0
},
"importerTax": {
"amount": 4.7
},
"duties": {
"amount": 2.4
},
"availableToRefundAmount": 14.7,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"amount": 10.0,
"description": "Client provides-Standard Ground - US",
"serviceLevel": "Client provides shipping service",
"taxAmount": 0.0
},
"metadata": {
"key2_OrderLevel": true,
"key1_OrderLevel": 12345
},
"upstreamId": "fe18c37b-f76b-4eaa-892a-b1aca88cf46d",
"updatedTime": "2021-01-07T01:03:58Z",
"browserIp": "161.69.112.12",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"liveMode": false,
"payment": {
"charges": [
{
"id": "4dca9e66-5f4e-41de-bc97-27a589a0e7c9",
"createdTime": "2021-01-07T01:02:58Z",
"currency": "USD",
"amount": 27.1,
"state": "complete",
"captured": true,
"captures": [
{
"id": "e0b9c853-3a26-47e6-9d49-025a1d4f8b6b",
"createdTime": "2021-01-07T01:03:16Z",
"amount": 27.1,
"state": "complete"
}
],
"refunded": true,
"refunds": [
{
"createdTime": "2021-01-07T01:06:26Z",
"amount": 12.4,
"state": "complete"
},
{
"createdTime": "2021-01-07T01:11:20Z",
"amount": 12.4,
"state": "complete"
}
],
"sourceId": "7e2dfaae-42a6-4b21-867b-73b7c5ee2c74",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "7e2dfaae-42a6-4b21-867b-73b7c5ee2c74",
"type": "creditCard",
"amount": 27.1,
"owner": {
"firstName": "test",
"lastName": "test",
"email": "abc@test.com",
"address": {
"line1": "1234 St.",
"city": "Minnetonka",
"postalCode": "55341",
"state": "MN",
"country": "US"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 8,
"expirationYear": 2525,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "76a2b825-2cf6-45a3-a193-356ef431f309",
"amountContributed": 27.1,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "76a2b825-2cf6-45a3-a193-356ef431f309_eac08379-f5a8-4b78-bc23-ad2a26515df2"
}
},
"state": "complete",
"stateTransitions": {
"fulfilled": "2021-01-07T01:03:17Z",
"accepted": "2021-01-07T01:02:59Z",
"complete": "2021-01-07T01:03:41Z"
},
"fraudStateTransitions": {
"passed": "2021-01-07T01:02:59Z"
},
"requestToBeForgotten": false,
"capturedAmount": 27.1,
"cancelledAmount": 0.0,
"availableToRefundAmount": 14.7,
"checkoutId": "183237120336"
}
},
"liveMode": false,
"createdTime": "2021-11-01T18:03:14.290143Z",
"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"
}checkout_session.order.created
checkout_session.order.createdFor details, refer to Handling completed checkout-sessions.
{
"id": "dacc88d7-3f88-469b-9764-35a15681e6c9",
"type": "checkout_session.order.created",
"data": {
"object": {
"id": "245558830336",
"checkoutId": "b02686da-decf-4122-b922-d7dc39ed8a08",
"checkoutSessionId": "158214a9-0a91-41bf-86eb-0aa9b7c713cc",
"createdTime": "2022-11-08T20:39:17Z",
"currency": "KRW",
"email": "jdoe@digitalriver.com",
"shipTo": {
"address": {
"line1": "123 Elm St",
"city": "Plainsville",
"postalCode": "55404",
"state": "MN",
"country": "US"
},
"name": "John Doe",
"phone": "6124327861",
"email": "jdoe@digitalriver.com",
"saveForLater": false
},
"shipFrom": {
"address": {
"country": "KR"
}
},
"billTo": {
"address": {
"line1": "123 Elm St",
"city": "Plainsville",
"postalCode": "55404",
"state": "MN",
"country": "US"
},
"name": "John Doe",
"phone": "6124327861",
"email": "jdoe@digitalriver.com",
"saveForLater": false
},
"totalAmount": 139000.0,
"subtotal": 139000.0,
"totalFees": 0.0,
"totalTax": 0.0,
"totalImporterTax": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 7000.0,
"items": [
{
"id": "174292610336",
"sku": {
"id": "sku-phy-thor-gb",
"name": "Thor's Ankleboot",
"eccn": "EAR99",
"taxCode": "531029.200",
"image": "https://drapi.io/img/prod/shoes_men_ankleboot.png",
"physical": true
},
"amount": 132000.0,
"quantity": 1,
"tax": {
"rate": 0.0,
"amount": 0.0
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"availableToRefundAmount": 0.0,
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shippingChoice": {
"amount": 7000.0,
"description": "Standard Shipping",
"serviceLevel": "SG",
"taxAmount": 0.0
},
"updatedTime": "2022-11-08T20:39:17Z",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "DR_INC-ENTITY",
"name": "Digital River Inc."
},
"payment": {
"charges": [
{
"id": "241c56c8-82bc-434f-a761-7bfba9c515de",
"createdTime": "2022-11-08T20:39:19Z",
"currency": "KRW",
"amount": 139000.0,
"state": "capturable",
"captured": false,
"refunded": false,
"sourceId": "2d7caab1-4607-4d8a-93b7-1df132b097aa",
"type": "customer_initiated"
}
],
"sources": [
{
"id": "2d7caab1-4607-4d8a-93b7-1df132b097aa",
"createdTime": "2022-11-08T20:39:14Z",
"type": "creditCard",
"currency": "KRW",
"amount": 139000.0,
"reusable": false,
"state": "consumed",
"owner": {
"firstName": "John",
"lastName": "Doe",
"email": "jdoe@digitalriver.com",
"address": {
"line1": "123 Elm St",
"city": "Plainsville",
"postalCode": "55404",
"state": "MN",
"country": "US"
}
},
"paymentSessionId": "478274eb-2e61-4016-8665-fc9171c7e470",
"clientSecret": "2d7caab1-4607-4d8a-93b7-1df132b097aa_ecdd5072-3360-487b-81a1-73557bab12be",
"creditCard": {
"brand": "MasterCard",
"expirationMonth": 12,
"expirationYear": 2023,
"lastFourDigits": "0008",
"fundingSource": "credit"
}
}
],
"session": {
"id": "478274eb-2e61-4016-8665-fc9171c7e470",
"amountContributed": 139000.0,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "478274eb-2e61-4016-8665-fc9171c7e470_078fe948-c882-4b99-bc28-d5d15223e9bf"
}
},
"state": "accepted",
"stateTransitions": {
"accepted": "2022-11-08T20:39:20Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"passed": "2022-11-08T20:39:20Z"
},
"taxInclusive": false,
"consents": {
"termsOfService": true,
"eula": true,
"termsOfSale": true
},
"pricingFormat": {
"currencyNumberFormat": "#,###.##",
"symbol": "₩",
"decimalPlaces": 0,
"currencySymbolBeforePrice": true,
"useCurrencySymbolSpace": false
},
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2022-11-08T20:39:21.54565Z",
"digitalriverVersion": "2021-03-23"
}odeSubscription 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.
{
"id": "f005e032-26a2-4402-ab7a-25014b96b09d",
"type": "subscription.created",
"data": {
"object": {
"id": "24efc9af-f93a-4614-9417-02cb8a1f2d56",
"createdTime": "2022-11-01T20:36:31Z",
"updatedTime": "2022-11-01T20:36:31Z",
"stateTransitions": {},
"taxInclusive": false,
"currency": "USD",
"planId": "83549e2e-8fa7-4af7-b478-bad88c6af0ef",
"state": "draft",
"items": [
{
"price": 100.0,
"skuId": "7087dfa7-1dc0-4f4c-be9d-7622fbdad53e",
"quantity": 1
}
],
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2022-11-01T20:36:31.605142Z",
"digitalriverVersion": "2021-12-13"
}subscription.deleted
subscription.deletedRefer to Deleting subscriptions on the Subscription management page for details.
{
"id": "a017afd7-a42d-46c2-90fb-1d6e19740bd0",
"type": "subscription.deleted",
"data": {
"object": {},
"previousAttributes": {
"createdTime": "2022-11-01T20:36:31Z",
"currency": "USD",
"id": "24efc9af-f93a-4614-9417-02cb8a1f2d56",
"items": [
{
"price": 100.0,
"skuId": "7087dfa7-1dc0-4f4c-be9d-7622fbdad53e",
"quantity": 1
}
],
"liveMode": false,
"planId": "83549e2e-8fa7-4af7-b478-bad88c6af0ef",
"state": "draft",
"stateTransitions": {},
"taxInclusive": false,
"updatedTime": "2022-11-01T20:36:31Z"
}
},
"liveMode": false,
"createdTime": "2023-01-30T19:56:18.952174Z",
"digitalriverVersion": "2021-12-13"
}subscription.extended
subscription.extendedFor details, refer to the following topics:
Handling successful renewals on the Subscription management page.
{
"id": "6a44a90e-375e-4857-9976-2c1183936e7c",
"type": "subscription.extended",
"data": {
"object": {
"subscription": {
"contractBindingUntil": "2023-08-25T21:09:39.061+0000",
"createdTime": "2022-08-25T21:09:14.115+0000",
"updatedTime": "2022-08-25T21:10:00.034+0000",
"stateTransitions": {
"activated": "2022-08-25T21:10:00.033+0000"
},
"id": "36921d5e-53f6-4d4e-b5e7-a597496fe2a0",
"billingAgreementId": "6f63c1cd-7c02-4698-a6f7-bea987f94867",
"customerId": "ac34ed22-c23b-4b43-b522-ed6642d49375",
"sourceId": "c07d104e-4a80-4218-9bad-eb9c47635036",
"taxInclusive": false,
"currency": "USD",
"planId": "fc434aac-d43e-4382-ab7a-cc4492917391",
"locale": "en_US",
"state": "active",
"siteId": "6q9cbfuj",
"items": [
{
"price": 5.01,
"skuId": "231ac1b1-ad3e-4c76-9122-3cd1c156a3b5",
"quantity": 5
}
],
"currentPeriodEndDate": "2022-10-25T21:09:39.061+0000",
"nextInvoiceDate": "2022-10-25T21:09:39.061+0000",
"nextReminderDate": "2022-10-22T21:09:39.061+0000"
},
"invoice": {
"id": "cec27db855f64c7d863142ee2bc28af8",
"createdTime": "2022-08-25T21:09:48Z",
"updatedTime": "2022-08-25T21:09:59Z",
"customerId": "ac34ed22-c23b-4b43-b522-ed6642d49375",
"email": "testdummy@digitalriver.com",
"currency": "USD",
"description": "365 Days Plan Paid Monthly",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "DR_INC-ENTITY",
"name": "Digital River Inc."
},
"subtotal": 25.05,
"totalTax": 1.89,
"totalFees": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 0.0,
"totalAmount": 26.94,
"totalImporterTax": 0.0,
"collectionPeriodDays": 0,
"items": [
{
"id": "165126030336",
"skuId": "231ac1b1-ad3e-4c76-9122-3cd1c156a3b5",
"productDetails": {
"id": "231ac1b1-ad3e-4c76-9122-3cd1c156a3b5",
"name": "Athena Womens Running Shoes",
"countryOfOrigin": "US",
"image": "https://myproducts.com/productImage.jpg"
},
"amount": 25.05,
"quantity": 5,
"tax": {
"rate": 0.07525,
"amount": 1.89
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"subscriptionInfo": {
"subscriptionId": "36921d5e-53f6-4d4e-b5e7-a597496fe2a0",
"planId": "fc434aac-d43e-4382-ab7a-cc4492917391",
"autoRenewal": true,
"freeTrial": false,
"billingAgreementId": "6f63c1cd-7c02-4698-a6f7-bea987f94867"
},
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shipTo": {
"address": {
"line1": "9625 West 76th St",
"line2": "Ste 1",
"city": "Eden Prairie",
"postalCode": "55344-3765",
"state": "MN",
"country": "US"
},
"name": "Automation Tester",
"phone": "952-253-1234 x132",
"email": "test@digitalriver.com"
},
"billTo": {
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "Digital Development",
"email": "testdummy@digitalriver.com",
"organization": "DR",
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"state": "paid",
"stateTransitions": {
"draft": "2022-08-25T21:09:48Z",
"paid": "2022-08-25T21:09:59Z",
"open": "2022-08-25T21:09:50Z"
},
"attemptCount": 1,
"chargeType": "merchant_initiated",
"upstreamId": "ab84e87b-d7e6-4f93-b758-ca98d396dd3f",
"orderId": "237569660336",
"payment": {
"charges": [
{
"id": "f77df415-20f3-4368-91b2-fecec7d07f35",
"createdTime": "2022-08-25T21:09:57Z",
"currency": "USD",
"amount": 26.94,
"state": "processing",
"captured": true,
"captures": [
{
"id": "753a5af6-b8da-4571-b9e1-62fc7b64d52a",
"createdTime": "2022-08-25T21:10:00Z",
"amount": 26.94,
"state": "pending"
}
],
"refunded": false,
"sourceId": "c07d104e-4a80-4218-9bad-eb9c47635036",
"type": "merchant_initiated"
}
],
"sources": [
{
"id": "c07d104e-4a80-4218-9bad-eb9c47635036",
"type": "creditCard",
"amount": 26.94,
"owner": {
"firstName": "Digital",
"lastName": "Development",
"email": "testdummy@digitalriver.com",
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"organization": "DR",
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"creditCard": {
"brand": "MasterCard",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "0008",
"fundingSource": "credit"
}
}
],
"session": {
"id": "5c4be31d-1630-4f31-82d6-f81d52a7b4a7",
"amountContributed": 26.94,
"amountRemainingToBeContributed": 0.0,
"state": "complete",
"clientSecret": "5c4be31d-1630-4f31-82d6-f81d52a7b4a7_5f3691e1-888e-4381-8f08-04b73fb3dc96"
}
}
}
}
},
"liveMode": false,
"createdTime": "2022-08-25T21:10:00.529962Z"
}subscription.failed
subscription.failedRefer to Subscription failures on the Subscription management page for details.
{
"id": "d460fe1e-b18b-40cf-9da9-561a3186d1cf",
"type": "subscription.failed",
"data": {
"object": {
"id": "a0280a49-9395-4a2f-91c5-2fa2e523a7f9",
"contractBindingUntil": "2023-08-10T19:57:12Z",
"createdTime": "2022-08-10T19:56:55Z",
"updatedTime": "2022-08-10T19:58:31Z",
"stateTransitions": {
"failed": "2022-08-10T19:58:31Z",
"activated": "2022-08-10T19:57:12Z"
},
"billingAgreementId": "b7e64775-4d1f-4b20-b376-dca7616eb3eb",
"customerId": "83e899d3-a5a4-4671-8348-2512e71b4f3b",
"sourceId": "61e36cfb-0359-4470-8a4b-1cacecccf49f",
"taxInclusive": false,
"currency": "USD",
"planId": "f40eea1d-b079-4d6a-970a-80b89c36d87b",
"locale": "en_US",
"state": "failed",
"items": [
{
"price": 5.01,
"skuId": "52d2e7a7-b794-4257-a5c8-c8f193e81266",
"quantity": 5
}
],
"currentPeriodEndDate": "2022-09-10T19:57:12Z",
"nextInvoiceDate": "2022-09-10T19:57:12Z",
"nextReminderDate": "2022-09-07T19:57:12Z",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2022-08-10T19:58:31.795021Z",
"digitalriverVersion": "2021-12-13"
}subscription.payment_failed
subscription.payment_failedRefer to Payment failures on the Subscription management page for details.
{
"id": "ad173483-612b-4970-bfbd-83f0ef0a15dc",
"type": "subscription.payment_failed",
"data": {
"object": {
"subscription": {
"contractBindingUntil": "2023-08-28T01:32:04.000+0000",
"createdTime": "2022-09-06T01:32:03.000+0000",
"updatedTime": "2022-09-06T01:32:17.000+0000",
"stateTransitions": {
"activated": "2022-09-06T01:32:04Z"
},
"id": "f1e408c1-9ed5-4023-82fe-cbac5f013845",
"billingAgreementId": "billingAgreementId7",
"customerId": "adcfdedd-0e4c-46b4-bfc6-b4fa8f7b739a",
"sourceId": "7fe3e814-bfaa-4f5f-8eb0-3b9bec09b4e9",
"taxInclusive": true,
"currency": "USD",
"planId": "965b2c8b-0593-419a-9e76-9c1cf7ec602f",
"applicationId": "app123232332",
"state": "activePendingInvoice",
"items": [
{
"price": 15.0,
"skuId": "adcfdedd-0e4c-46b4-bfc6-b4fa8f7b739a",
"quantity": 2,
"metadata": {
"key3": "value3",
"key4": "value4"
}
}
],
"currentPeriodEndDate": "2022-10-06T01:32:04.000+0000",
"nextInvoiceDate": "2022-10-02T01:32:04.000+0000",
"metadata": {
"key1": "value1",
"key6": "value2"
},
"nextReminderDate": "2022-09-30T01:32:04.000+0000"
},
"invoice": {
"id": "846b0f41bb194965adefdb1aac00f9ab",
"createdTime": "2022-09-06T01:32:15Z",
"updatedTime": "2022-09-06T01:32:17Z",
"customerId": "adcfdedd-0e4c-46b4-bfc6-b4fa8f7b739a",
"email": "InvoiceApi_20210716112816081@digitalriver.com",
"currency": "USD",
"description": "Example Plan",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"subtotal": 27.9,
"totalTax": 2.1,
"totalFees": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 0.0,
"totalAmount": 30.0,
"totalImporterTax": 0.0,
"collectionPeriodDays": 5,
"items": [
{
"id": "48bcda38-5f00-48e5-93f2-93297f39edb3",
"skuId": "adcfdedd-0e4c-46b4-bfc6-b4fa8f7b739a",
"productDetails": {
"id": "adcfdedd-0e4c-46b4-bfc6-b4fa8f7b739a",
"name": "Athena Womens Running Shoes 3f4216e8-0eb1-4c0f-ba31-c657522b8848",
"countryOfOrigin": "US"
},
"amount": 27.9,
"quantity": 2,
"tax": {
"rate": 0.07525,
"amount": 2.1
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"subscriptionInfo": {
"subscriptionId": "f1e408c1-9ed5-4023-82fe-cbac5f013845",
"planId": "965b2c8b-0593-419a-9e76-9c1cf7ec602f",
"autoRenewal": true,
"freeTrial": false,
"billingAgreementId": "billingAgreementId7"
},
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shipTo": {
"address": {
"line1": "9625 West 76th St",
"line2": "Ste 1",
"city": "Eden Prairie",
"postalCode": "55344-3765",
"state": "MN",
"country": "US"
},
"name": "Automation Tester",
"phone": "952-253-1234 x132",
"email": "test@digitalriver.com"
},
"billTo": {
"address": {
"line1": "10380 Bren Rd W",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "Declined QA",
"email": "InvoiceApi_20210716112816081@digitalriver.com"
},
"state": "open",
"stateTransitions": {
"draft": "2022-09-06T01:32:15Z",
"open": "2022-09-06T01:32:17Z"
},
"attemptCount": 0,
"chargeType": "merchant_initiated",
"upstreamId": "4c9011ef-e502-42de-a4e2-dc295363a569",
"payment": {
"charges": [
{
"id": "c23afc9d-97a6-4039-923c-148f8b077468",
"createdTime": "2022-09-06T19:45:25Z",
"currency": "USD",
"amount": 30.0,
"state": "failed",
"captured": false,
"failureCode": "declined",
"refunded": false,
"sourceId": "7fe3e814-bfaa-4f5f-8eb0-3b9bec09b4e9",
"type": "merchant_initiated"
}
],
"sources": [
{
"id": "7fe3e814-bfaa-4f5f-8eb0-3b9bec09b4e9",
"type": "creditCard",
"amount": 30.0,
"owner": {
"firstName": "Declined",
"lastName": "QA",
"email": "InvoiceApi_20210716112816081@digitalriver.com",
"address": {
"line1": "10380 Bren Rd W",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 8,
"expirationYear": 2018,
"lastFourDigits": "3600"
}
}
],
"session": {
"id": "1cdcd197-6b0b-48d2-9c9f-f5334523f4a3",
"amountContributed": 30.0,
"amountRemainingToBeContributed": 0.0,
"state": "cancelled",
"clientSecret": "1cdcd197-6b0b-48d2-9c9f-f5334523f4a3_4012c476-db56-47c6-8f1b-577e6d84069a"
}
}
}
}
},
"liveMode": false,
"createdTime": "2022-09-06T19:45:28.371015Z"
}subscription.source_invalid
subscription.source_invalidFor details, refer to:
The Lifecycle of a subscription on the Subscriptions page
{
"id": "883bc7be-805c-45f9-b823-a603fe7e5074",
"type": "subscription.source_invalid",
"data": {
"object": {
"id": "d339930d-d34f-46ee-9baa-f1f765ae501e",
"contractBindingUntil": "2023-10-05T01:27:45Z",
"createdTime": "2023-09-05T01:27:39Z",
"updatedTime": "2023-09-05T01:27:46Z",
"stateTransitions": {
"activated": "2023-09-05T01:27:45Z"
},
"billingAgreementId": "05559906-c531-4f8e-862b-011d707ae4a6",
"customerId": "175ed1e4-da63-45e2-8155-27ff452fdcbb",
"sourceId": "0e103117-4175-4bcc-947c-75de1cea0ca0",
"taxInclusive": false,
"currency": "USD",
"planId": "3a7cff1d-2ebd-48ec-a7be-722399913f1b",
"locale": "en_US",
"state": "active",
"items": [
{
"price": 5.01,
"skuId": "175ed1e4-da63-45e2-8155-27ff452fdcbb",
"quantity": 5
}
],
"currentPeriodStartDate": "2023-09-05T01:27:45Z",
"currentPeriodEndDate": "2023-10-05T01:27:45Z",
"nextInvoiceDate": "2023-10-05T01:27:45Z",
"nextReminderDate": "2023-10-04T01:27:45Z",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2023-09-05T02:27:10.640756Z",
"digitalriverVersion": "2021-12-13"
}
subscription.lapsed
subscription.lapsedFor details, refer to:
The Lifecycle of a subscription on the Subscriptions page
{
"id": "e49215c2-5394-47bf-8469-aa6e395d5915",
"type": "subscription.lapsed",
"data": {
"object": {
"id": "e128cf63-d198-4772-8d2c-9baba0d9db85",
"contractBindingUntil": "2023-10-06T02:42:06Z",
"createdTime": "2023-09-06T02:41:59Z",
"updatedTime": "2023-09-06T03:10:45Z",
"stateTransitions": {
"lapsed": "2023-09-06T03:10:45Z",
"activated": "2023-09-06T02:42:06Z"
},
"billingAgreementId": "155436b5-fc97-4dfe-82b2-9125515b4abc",
"customerId": "c488599d-d089-467d-bcd0-c9d7884971de",
"sourceId": "afc73da4-fe1e-4652-8bd3-053bc3d4a4f8",
"taxInclusive": false,
"currency": "USD",
"planId": "dad9289a-bd1f-4f48-b413-0876cc0bca25",
"locale": "en_US",
"state": "lapsed",
"items": [
{
"price": 5.01,
"skuId": "c488599d-d089-467d-bcd0-c9d7884971de",
"quantity": 5
}
],
"currentPeriodStartDate": "2023-09-06T02:42:06Z",
"currentPeriodEndDate": "2023-09-20T02:42:06Z",
"nextInvoiceDate": "2023-09-20T02:42:06Z",
"nextReminderDate": "2023-09-19T02:42:06Z",
"liveMode": false
}
},
"liveMode": false,
"createdTime": "2023-09-06T03:10:45.375207Z",
"digitalriverVersion": "2021-12-13"
}subscription.reminder
subscription.reminderRefer to Sending a reminder on the Subscription management page for details.
{
"id": "2a64a220-6028-4b7e-aaaf-ebb7c49e174b",
"type": "subscription.reminder",
"data": {
"object": {
"subscription": {
"contractBindingUntil": "2022-10-21T02:20:46.000+0000",
"createdTime": "2022-09-21T02:20:33.000+0000",
"updatedTime": "2022-09-21T02:20:47.000+0000",
"stateTransitions": {
"activated": "2022-09-21T02:20:47Z"
},
"id": "e17840a4-6398-4bd4-9357-4184e3fda615",
"billingAgreementId": "2a6f7305-4740-417d-9fa9-9dd573152317",
"customerId": "e1ed4e3d-c435-4e62-a2d2-239c63a425a6",
"sourceId": "7b975915-af8c-4a63-84ab-f10379fec3de",
"taxInclusive": false,
"currency": "USD",
"planId": "9bce7832-301a-4e82-925f-ffa1ea723440",
"locale": "en_US",
"state": "active",
"items": [
{
"price": 5.01,
"skuId": "e1ed4e3d-c435-4e62-a2d2-239c63a425a6",
"quantity": 5
}
],
"currentPeriodEndDate": "2022-09-27T02:20:46.000+0000",
"nextInvoiceDate": "2022-09-27T02:20:46.000+0000",
"nextReminderDate": "2022-09-26T02:20:46.000+0000"
},
"invoice": {
"id": "f4340ec5578e4d1f9714c559c7b11abd",
"createdTime": "2022-09-26T00:01:33Z",
"updatedTime": "2022-09-26T00:01:33Z",
"customerId": "e1ed4e3d-c435-4e62-a2d2-239c63a425a6",
"email": "testdummy@digitalriver.com",
"currency": "USD",
"description": "Monthly Paid Every 3 Days Plan",
"locale": "en_US",
"customerType": "individual",
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"subtotal": 25.05,
"totalTax": 1.89,
"totalFees": 0.0,
"totalDuty": 0.0,
"totalDiscount": 0.0,
"totalShipping": 0.0,
"totalAmount": 26.94,
"totalImporterTax": 0.0,
"collectionPeriodDays": 0,
"items": [
{
"id": "bef79f9b-fa43-48da-b6fd-fefeaad13b09",
"skuId": "e1ed4e3d-c435-4e62-a2d2-239c63a425a6",
"productDetails": {
"id": "e1ed4e3d-c435-4e62-a2d2-239c63a425a6",
"name": "Athena Womens Running Shoes 3f4216e8-0eb1-4c0f-ba31-c657522b8848",
"countryOfOrigin": "US"
},
"amount": 25.05,
"quantity": 5,
"tax": {
"rate": 0.07525,
"amount": 1.89
},
"importerTax": {
"amount": 0.0
},
"duties": {
"amount": 0.0
},
"subscriptionInfo": {
"subscriptionId": "e17840a4-6398-4bd4-9357-4184e3fda615",
"planId": "9bce7832-301a-4e82-925f-ffa1ea723440",
"autoRenewal": true,
"freeTrial": false,
"billingAgreementId": "2a6f7305-4740-417d-9fa9-9dd573152317"
},
"fees": {
"amount": 0.0,
"taxAmount": 0.0
}
}
],
"shipTo": {
"address": {
"line1": "9625 West 76th St",
"line2": "Ste 1",
"city": "Eden Prairie",
"postalCode": "55344-3765",
"state": "MN",
"country": "US"
},
"name": "Automation Tester",
"phone": "952-253-1234 x132",
"email": "test@digitalriver.com"
},
"billTo": {
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"name": "Digital Development",
"email": "testdummy@digitalriver.com",
"organization": "DR",
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"state": "draft",
"stateTransitions": {
"draft": "2022-09-26T00:01:34Z"
},
"attemptCount": 0,
"chargeType": "merchant_initiated",
"upstreamId": "7e9f5607-af1a-47fa-b8bc-a3063f6fecee",
"payment": {
"sources": [
{
"id": "7b975915-af8c-4a63-84ab-f10379fec3de",
"type": "creditCard",
"amount": 26.94,
"owner": {
"firstName": "Digital",
"lastName": "Development",
"email": "testdummy@digitalriver.com",
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"postalCode": "55343",
"state": "MN",
"country": "US"
},
"organization": "DR",
"additionalAddressInfo": {
"neighborhood": "Centro"
}
},
"creditCard": {
"brand": "Visa",
"expirationMonth": 7,
"expirationYear": 2027,
"lastFourDigits": "1111"
}
}
],
"session": {
"id": "43fc529b-548f-4c7a-9e5a-e260f807568d",
"amountContributed": 26.94,
"amountRemainingToBeContributed": 0.0,
"state": "requires_confirmation",
"clientSecret": "43fc529b-548f-4c7a-9e5a-e260f807568d_f6ca21b8-dc38-47c9-bcb6-5710bcc6b851"
}
}
}
}
},
"liveMode": false,
"createdTime": "2022-09-26T00:01:35.367812Z"
}subscription.updated
subscription.updatedRefer to Updating subscriptions on the Subscription management page for details.
{
"id": "981a8e95-0379-4eb2-b0fe-2d02feec9fa4",
"type": "subscription.updated",
"data": {
"object": {
"id": "1ec4e3ff-a26e-4cff-9d51-208c95e46d2f",
"contractBindingUntil": "2023-10-25T15:50:04Z",
"createdTime": "2022-10-25T15:48:51Z",
"updatedTime": "2022-10-25T15:50:04Z",
"stateTransitions": {
"activated": "2022-10-25T15:50:04Z"
},
"billingAgreementId": "2886790e-d775-43ad-9210-b9b52eac0903",
"customerId": "596713180336",
"sourceId": "633a96ae-6a1b-4d2c-9fb0-16473dfb6110",
"taxInclusive": false,
"currency": "USD",
"planId": "66c2659f-cf41-4f78-a2d1-6a9bae5b447c",
"state": "active",
"items": [
{
"price": 100.0,
"skuId": "df9d00e7-776c-44d0-b34c-454a340caec2",
"quantity": 1
}
],
"currentPeriodEndDate": "2022-11-25T15:50:04Z",
"nextInvoiceDate": "2022-11-20T15:50:04Z",
"nextReminderDate": "2022-11-15T15:50:04Z",
"liveMode": false
},
"previousAttributes": {
"billingAgreementId": null,
"contractBindingUntil": null,
"currentPeriodEndDate": null,
"customerId": null,
"nextInvoiceDate": null,
"nextReminderDate": null,
"sourceId": null,
"state": "draft",
"stateTransitions": {
"activated": null
},
"updatedTime": "2022-10-25T15:48:51Z"
}
},
"liveMode": false,
"createdTime": "2022-10-25T15:50:04.834797Z",
"digitalriverVersion": "2021-12-13"
}Last updated