Order basics
Learn more about the orders resource.
Orders handle customers' purchases. When you create an order, you instruct Digital River, the authorized reseller, to send an authorization request to start the collection process.
The data of an order persist, acting as a permanent record of the sale, which Digital River must maintain for auditing purposes.
An order maintains an enduring record of when it was placed, a charge is created and captured, a refund is processed, and other key events in the order lifecycle occur. More specifically, an order persists:
A charge containing a payment source, an amount charged to that source, and the state of the charge
The following diagram depicts the relationship between an order and other resources in the Digital River APIs.
To ensure that your integration is functioning properly, you can create test orders using the information on the Testing Scenarios page.
The orders resource
In the following section, you'll find information on some of an order's attributes and how you might use them in downstream requests. For a complete list, refer to the Orders API reference documentation.
Unique identifier
An order contains a unique id. You can use this identifier when initiating physical fulfillments, cancelling shipments, capturing and cancelling payments, creating physical returns, handling third-party returns, and issuing refunds.
{
"id": "177452480336",
...Ship to values
An order's shipTo values are displayed on invoices and credit memos.
...
"customerId": "987654321",
...
"shipTo": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "string",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "Jane Doe",
"phone": "952-111-1111",
"email": "[email protected]",
"organization": "Digital River"
},Amounts, fees, and taxes
The total amount, fees, taxes, and other order costs are the same as those presented to customers when they confirm the purchase. You can retrieve these values and display them on the customer's order confirmation page.
...
"totalAmount": 177.67,
"subtotal": 172.5,
"totalFees": 0.0,
"totalTax": 5.17,
"totalDuty": 0.0,
"totalDiscount": 7.5,
"totalShipping": 5.0,
...Line items
Digital River assigns each of an order's items[] a unique id. You need this identifier when capturing and cancelling payments, handling third-party returns, and issuing refunds.
Depending on how you send product data in checkouts, each of an order's items[] also contains either a skuId or a productDetails object.
In addition, these items[] store detailed price, tax, and quantity information that you can display to customers on order confirmation and order detail pages.
For more information on subscriptionInfo, refer to the Subscription information page.
...
"items": [
{
"id": "96415480336",
"skuId": "08141946",
"amount": 100.0,
"quantity": 1,
"state": "created",
"stateTransitions": {
"created": "2020-05-21T17:26:34Z"
},
"tax": {
"rate": 0.0,
"amount": 0.0
},
"subscriptionInfo": {
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"terms": "Insert terms here",
"autoRenewal": true,
"freeTrial": false
}
},
{
"id": "96415490336",
"skuId": "05081978",
"amount": 67.5,
"quantity": 1,
"discount": {
"percentOff": 10.0,
"quantity": 1
},
"state": "created",
"stateTransitions": {
"created": "2020-05-21T17:26:34Z"
},
"tax": {
"rate": 0.07125,
"amount": 4.81
}
}
],
...Tax invoices and credit memos
In most cases, Digital River populates an order's invoicePDFs and creditMemoPDFs with information that you can use to access and share tax invoices and credit memo files.
...
"invoicePDFs": [
{
"url": "https://api.digitalriver.com/files/23c7e1a5-25e4-41a9-b935-eda98dfa238b/content",
"id": "23c7e1a5-25e4-41a9-b935-eda98dfa238b"
}
],
"creditMemoPDFs": [
{
"url": "https://api.digitalriver.com/files/5cec4a32-853f-485a-90a0-15ea0a614355/content",
"id": "5cec4a32-853f-485a-90a0-15ea0a614355"
}
],
...State and fraud state
For more information about an order's state and fraudState, refer to the Order lifecycle page.
Tax identifiers
Orders with applied tax identifiers contain an array of tax identifier objects.
...
"taxIdentifiers": [{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"customerId": "5774321009",
"type": "uk",
"value": "GB000283536",
"state": "verified",
"stateTransitions":
{"pending": "2020-05-13T11:00:00.000Z", "verified": "2020-05-15T16:00:00.000Z"},
"verified_name": "Descon Ltd",
"verified_address": "Design House, 18b Tromode, Isle of Man",
"createdTime": "2020-08-01T02:25:53Z",
"updatedTime": "2020-08-01T05:47:21Z"
}],
...Charges
An order's charges[] contains one or more elements, each representing a charge created from a primary or secondary payment source. Each charge contains a unique identifier, an amount, a state, and the identifier of the payment source used to create the charge.
...
"charges": [
{
"id": "d3a02b03-1378-431e-81a5-9cb6dd54d90b",
"createdTime": "2020-05-21T17:26:37Z",
"currency": "USD",
"amount": 177.67,
"state": "capturable",
"captured": false,
"refunded": false,
"sourceId": "deabb3a4-14e4-4702-a13b-ddaac23277d3"
}
],
...Request to be forgotten
An order's requestToBeForgotten indicates whether an order's data is scheduled for deletion. It is the only attribute (other than metadata) that you can modify in an update order request.
...
"requestToBeForgotten": false,
...
}Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.
Order ID
Enhanced Payload
GET /orders/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "ord_5823594809",
"checkoutId": "5823594809",
"createdTime": "2018-04-25T20:36:00Z",
"customerId": "cus_5774321009",
"currency": "usd",
"email": "[email protected]",
"language": "en",
"locale": "en_IE",
"browserIp": "111.111.111.111",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"taxIdentifiers": [
{
"id": "5774321009",
"createdTime": "2018-04-25T20:36:00Z",
"customerId": "5774321009",
"type": "de",
"value": "DE123456789",
"state": "pending",
"stateTransitions": {
"pending": "2018-04-25T20:36:00Z",
"verified": "2018-04-25T20:36:00Z",
"not_valid": "2018-04-25T20:36:00Z"
},
"verifiedName": ".",
"verifiedAddress": ".",
"updatedTime": "2018-04-25T20:36:00Z"
}
],
"invoiceAttributes": {
"id": "1234",
"type": "cn_business_general",
"customerId": "5678",
"atttributes": [
{
"invoiceTitle": "Invoice title",
"regAccount": "87654",
"regAddress": "123 Example st.",
"regBank": "Bank",
"regPhone": "8005551234"
}
],
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"liveMode": false
},
"shipFrom": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
},
"shipTo": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "John Smith",
"phone": "952-111-1111",
"email": "[email protected]",
"organization": "Digital River",
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
},
"billTo": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "John Smith",
"phone": "952-111-1111",
"email": "[email protected]",
"organization": "Digital River",
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ",
"title": "M"
}
},
"organization": {
"id": "123456789"
},
"subtotal": 1094.5,
"totalTax": 82.76,
"totalImporterTax": 82.76,
"importerOfRecordTax": true,
"totalFees": 0,
"totalDuty": 0,
"totalDiscount": 0,
"totalShipping": 5.76,
"totalAmount": 1180.26,
"discount": {
"amountOff": 5.95,
"percentOff": 100
},
"availableToRefundAmount": 18.58,
"refundedAmount": 1,
"cancelledAmount": 1,
"capturedAmount": 1,
"items": [
{
"id": "100067660336",
"skuId": "sku_5823594809",
"productDetails": {
"id": "100067660336",
"skuGroupId": "wireless-keyboards",
"name": "Keyboard",
"description": "Top rated keyboard",
"itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
"url": "https://producturl.com",
"countryOfOrigin": "US",
"image": "https://imageurl.com",
"weight": 20.5,
"weightUnit": "oz",
"partNumber": "SWG1224J10L",
"partnerAccountId": "00g6atnynbl2wFsFG357"
},
"logisticsOptions": {
"deliveryOptions": [
"[\"direct_delivery_only\",\"additional_handling\"]"
],
"dangerousGoods": [
"nimh_battery"
]
},
"subscriptionInfo": {
"freeTrial": true,
"autoRenewal": true,
"terms": "Please accept these terms.",
"planId": "654321",
"subscriptionId": "665430999",
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"startTime": "2020-05-21T00:00:00Z",
"endTime": "2021-05-20T11:59:59Z"
},
"fees": {
"details": [
{
"type": "battery",
"amount": 3,
"perUnitAmount": 1.5,
"id": "asdkj1h239lkj123j9123"
}
],
"amount": 4.5,
"taxAmount": 1.2
},
"quantity": 2,
"state": "created",
"stateTransitions": {
"created": "2025-06-25T14:26:42.343Z",
"fulfilled": "2025-06-25T14:26:42.343Z",
"paid": "2025-06-25T14:26:42.343Z",
"cancelled": "2025-06-25T14:26:42.343Z",
"blocked": "2025-06-25T14:26:42.343Z",
"returned": "2025-06-25T14:26:42.343Z"
},
"amount": 18.58,
"availableToRefundAmount": 18.58,
"sellerTaxIdentifier": "IE6426071C",
"tax": {
"rate": 0.0675,
"amount": 89
},
"importerTax": {
"amount": 12.34
},
"duties": {
"amount": 12.34
},
"discount": {
"amountOff": 5.95,
"percentOff": 100,
"quantity": 1
},
"shipFrom": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
},
"shipping": {
"amount": 5.99,
"taxAmount": 1.99
},
"metadata": {
"coupon": "iOS"
}
}
],
"billingOptimization": {
"subscriptionId": "13763570010",
"segmentId": "22070943100",
"renewalAttemptNumber": 1,
"trackingId": "39784"
},
"invoicePDFs": [
{
"id": "text",
"url": "text"
}
],
"creditMemoPDFs": [
{
"id": "text",
"url": "text"
}
],
"requestToBeForgotten": true,
"shippingChoice": {
"id": "100067660336",
"amount": 5.95,
"taxAmount": 0.1,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground",
"shippingTerms": "DDP"
},
"state": "created",
"stateTransitions": {
"accepted": "2025-06-25T14:26:42.343Z",
"pending_payment": "2025-06-25T14:26:42.343Z",
"in_review": "2025-06-25T14:26:42.343Z",
"complete": "2025-06-25T14:26:42.343Z",
"dispute": "2025-06-25T14:26:42.343Z",
"cancelled": "2025-06-25T14:26:42.343Z",
"fulfilled": "2025-06-25T14:26:42.343Z",
"blocked": "2025-06-25T14:26:42.343Z",
"returned": "2025-06-25T14:26:42.343Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-06-25T14:26:42.343Z",
"review_opened": "2025-06-25T14:26:42.343Z",
"passed": "2025-06-25T14:26:42.343Z"
},
"cancelReason": "fraud",
"payment": {
"sources": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
"createdTime": "2018-04-25T20:36:00Z",
"type": "creditCard",
"currency": "USD",
"amount": 1180.26,
"reusable": true,
"owner": {
"firstName": "John",
"lastName": "Smith",
"email": "[email protected]",
"organization": "Digital River",
"upstreamId": "55129-54673",
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
},
"creditCard": {
"lastFourDigits": "3119",
"expirationMonth": 3,
"expirationYear": 2023,
"brand": "Visa"
},
"googlePay": {
"lastFourDigits": "3119",
"expirationMonth": 2,
"expirationYear": 2022,
"brand": "Visa"
},
"payPal": {
"redirect": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"cancelUrl": "https://mypage.com/cancel"
},
"directDebit": {
"token": "EC-53H39048EL439164J"
}
},
"payPalBilling": {
"redirect": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"cancelUrl": "https://mypage.com/cancel"
},
"directDebit": {
"token": "EC-53H39048EL439164J"
}
},
"payPalCredit": {
"redirect": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"cancelUrl": "https://mypage.com/cancel"
},
"directDebit": {
"token": "EC-53H39048EL439164J"
}
},
"directDebit": {
"redirect": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success"
}
},
"wireTransfer": {
"accountHolder": "Netgiro Payments AB",
"bankName": "ABN AMRO Bank N.V.",
"city": "Prague",
"country": "ES",
"referenceId": "DR1651067521",
"accountNumber": "0100037259",
"additionalBankInformation": "Codigo de oficina: 0001 Codigo de entidad: 0156 Digitos de control: 09",
"iban": "ES35 0156 0001 0901 0003 7259",
"swiftCode": "string"
},
"payCo": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"payCo": {}
},
"alipay": {},
"applePay": {},
"bPay": {
"accountHolder": "Global Collect BV",
"bankName": "Commonwealth Bank",
"city": "Sydney",
"country": "Australia",
"referenceId": "12345678",
"accountNumber": "87654321",
"billId": "112233",
"customerPaymentReference": "443322",
"swiftCode": "CTBAAU2S"
},
"onlineBanking": {
"bankCode": "86"
},
"codJapan": {},
"klarnaCredit": {
"shipping": {
"recipient": "John Doe",
"phoneNumber": "5559895326",
"address": {
"line1": "10380 Bren Road West",
"city": "Minnetonka",
"state": "MN",
"country": "US",
"postalCode": "55343"
},
"email": "[email protected]"
},
"token": "1111222233334444"
},
"klarnaCreditRecurring": {
"returnUrl": "https://example.org/return",
"cancelUrl": "https://example.org/cancel"
},
"konbini": {
"storeId": "33334444",
"receiptNumber": "8675309",
"printableInvoiceUrl": "https://printableinvoice.com",
"storeName": "Seven Eleven",
"localizedStoreName": "セブン‐イレブン",
"storeLogoUrl": "https://storelogo.com"
},
"bankTransfer": {},
"msts": {},
"bancontact": {},
"ideal": {},
"giftCard": {
"cardCurrency": "USD",
"conversionRate": 1,
"lastFourDigits": 8139
},
"amazonPay": {},
"afterPay": {},
"ccAvenue": {},
"flow": "standard",
"state": "chargeable",
"metadata": {
"coupon": "iOS"
},
"customerId": "5823594809",
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"liveMode": false
}
],
"charges": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"currency": "USD",
"amount": 1180.26,
"state": "pending",
"orderId": "9986340012",
"sourceId": "9986340012",
"failureCode": "a failure code",
"failureMessage": "a failure message",
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"cancels": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captures": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captured": false,
"refunds": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": "2018-04-25T20:36:00Z",
"updatedTime": "2018-04-25T20:36:00Z",
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"refunded": false,
"type": "customer_initiated",
"liveMode": true
}
],
"session": {
"id": "5823594809",
"amountContributed": 10.5,
"amountRemainingToBeContributed": 5.5,
"clientSecret": "f93b4a5a-6971-4a50-b752-58636f9cfa07_35436acd-7d47-41df-8e5",
"state": "requires_confirmation",
"nextAction": {
"action": "redirect",
"data": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/3fab742c-a7e8-4a90-8951-86d071fa070d?apiKey=pk_test_a45b91ba4f984df7a229b2ab5941ce1c",
"sourceId": "9c00d78c-dbad-4303-b366-7e0a49c322e7",
"sourceClientSecret": "9c00d78c-dbad-4303-b366-7e0a49c322e7_246ed54a-0dfc-41f0-9e98-14036adf642e",
"sessionId": "f61e26be-5f38-4f39-9ae9-0b3cbff6a14e",
"fingerprintToken": "fingerprintToken123",
"challengeToken": "challengeToken123",
"originKey": "originKey123"
}
}
}
},
"disclosures": {
"type": "termsOfSale",
"entityName": "Digital River Inc.",
"entityId": "DR_INC-ENTITY",
"localizedText": "Terms of Sale",
"url": "https://store.digitalriver.com/store/defaults/en_US/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Inc."
},
"liveMode": true,
"metadata": {
"coupon": "iOS"
},
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"customerType": "individual",
"chargeType": "merchant_initiated",
"upstreamId": "0916805858",
"updatedTime": "2018-04-25T20:37:00Z"
}The order lifecycle
An order has a defined lifecycle. Each stage of that lifecycle is represented by state. When an order's state changes, an event is created that represents that change. For example, when an order's state transitions from accepted to fulfilled an order.fulfilled event is created.
Order states and events
The following lists an order's enumerated state values and the events associated with each state change. These state transitions are listed in the approximate sequence they might occur in an order's lifecycle:
charge isn't yet capturable and could still be pending fraud review
charge is capturable, but the order requires further fraud review, and, as a result, is still not ready to fulfill
charge is capturable, has passed fraud review or the Denied Parties List (DPL), and is ready to fulfill
fails because it is blocked by fraud review or the customer is determined to be on the DPL
blocked
is completely fulfilled or partially fulfilled and the remaining items[] are cancelled
is fulfilled and the charge is fully captured or partially fulfilled with a partially captured charge and the remaining items[] are cancelled or
the order charge is complete
complete
is fully returned or partially returned and its remaining items[] are cancelled or partially/fully refunded
returned
order.refunded
The state values for a successful order (i.e. the happy path) are pending_payment > in_review > accepted > fulfilled > complete . As the order moves from one state to another, that event is recorded with a timestamp in stateTransitions.
Fraud review
An order must also pass through a fraud review. When exactly this review occurs in an order's lifecycle depends on the payment method used by the customer. The different stages of the review are represented by fraudState, whose enumerated values are review_opened, blocked, and passed. When fraudState changes, an event is created.
Last updated