Orders
The Orders resource in the Digital River API facilitates the management of end-customer purchases. It provides comprehensive functionalities to create, retrieve, update, and list orders. This resource is essential for tracking sales, processing transactions, and managing inventory. By using the Orders API, businesses can streamline their order management workflow and enhance customer experience.
Get all orders.
Authorizations
Query parameters
endingBeforestringOptional
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
startingAfterstringOptional
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
limitinteger · min: 1 · max: 100Optional
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
idsstring[]Optional
Only return objects with these IDs.
upstreamIdsstring[]Optional
Only return objects with these upstreamIds.
statestringOptional
Only return objects in the given state
customerIdstringOptional
Only return orders for the given customer
checkoutIdstringOptional
Only return orders for the given checkout
applicationIdstringOptional
Only return orders for the given application
emailstringOptional
Only return orders with the given email
currencystringOptional
Only return orders in the given currency
skuIdstringOptional
Only return orders containing this sku
fraudStatestringOptional
Only return orders in the given fraudState
browserIpstringOptional
Only return checkouts with this browser IP
chargeTypestringOptional
Only return orders with this charge type
subscriptionIdstringOptional
Only return orders with this subscription identifier
refundedAmountstringOptional
Only return orders with this refunded amount
localestringOptional
Only return checkouts with this locale
customerTypestringOptional
Only return checkouts with this customer type
Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /orders HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"hasMore": true,
"data": [
{
"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-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"paid": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"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-07-03T04:36:08.609Z",
"pending_payment": "2025-07-03T04:36:08.609Z",
"in_review": "2025-07-03T04:36:08.609Z",
"complete": "2025-07-03T04:36:08.609Z",
"dispute": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-07-03T04:36:08.609Z",
"review_opened": "2025-07-03T04:36:08.609Z",
"passed": "2025-07-03T04:36:08.609Z"
},
"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"
}
]
}Creates a new order. For more details, refer to Converting a checkout to an order.
Authorizations
Body
checkoutIdstringOptionalExample:
The unique identifier of a Checkout.
5823594809customerIdstringOptionalExample:
The identifier of the Customer associated with the Checkout.
5774321009sourceIdstringOptionalExample:
The unique identifier of a Source.
src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37currencystringOptionalExample:
A three-letter ISO 4217 currency code.
USDlanguagestring · enumOptionalExample:
The assigned language.
enPossible values: localestringOptionalExample:
A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
en_IEinvoiceAttributeIdstringOptionalExample:
The unique identfier of the invoice attribute.
95f72e0c-cb7d-48e1-93c8-998668ad0ff4applicationIdstringOptionalExample:
An arbitrary string identifier that can be used to track the application type.
68f72e0c-cb7d-48e1-93c8-998668ad0ff4browserIpstringOptionalExample:
The IP address of the browser used by the customer when placing the order.
111.111.111.111taxInclusivebooleanOptionalExample:
If true, indicates that the prices supplied are tax inclusive.
truechargeTypestring · enumOptionalExample:
Represents the charge type.
merchant_initiatedPossible values: customerTypestring · enumOptionalExample:
The type of customer.
individualPossible values: upstreamIdstringOptionalExample:
Any identifier that you want to associate with the resource. For tracking purposes, we recommend you provide the universally unique identifier (UUID) that identifies the corresponding order in your system. Unlike metadata, you can use this value as a query parameter in GET requests.
7765374748Responses
201
201 Created
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /orders HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2441
{
"checkoutId": "5823594809",
"customerId": "5774321009",
"sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37",
"currency": "USD",
"email": "[email protected]",
"language": "en",
"locale": "en_IE",
"invoiceAttributeId": "95f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"browserIp": "111.111.111.111",
"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"
},
"shippingChoice": {
"id": "100067660336",
"amount": 5.95,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground",
"shippingTerms": "DDP"
},
"discount": {
"amountOff": 5.95,
"percentOff": 100
},
"billingOptimization": {
"subscriptionId": "13763570010",
"segmentId": "22070943100",
"renewalAttemptNumber": 1,
"trackingId": "39784"
},
"items": [
{
"skuId": "5823594809",
"price": 9.99,
"discount": {
"amountOff": 10
}
},
{
"skuId": "5823594809",
"price": 9.99,
"quantity": 2,
"discount": {
"amountOff": 10
}
},
{
"skuId": "9234276173",
"price": 9.99,
"quantity": 2
}
],
"shippingDiscount": {
"amountOff": 5.95,
"percentOff": 100
},
"taxInclusive": true,
"taxIdentifiers": [
{
"id": "028af316-2d82-4113-8c5d-72eb82d5d025"
}
],
"chargeType": "merchant_initiated",
"customerType": "individual",
"metadata": {
"coupon": "iOS"
},
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"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."
}
],
"upstreamId": "7765374748"
}{
"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-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"paid": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"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-07-03T04:36:08.609Z",
"pending_payment": "2025-07-03T04:36:08.609Z",
"in_review": "2025-07-03T04:36:08.609Z",
"complete": "2025-07-03T04:36:08.609Z",
"dispute": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-07-03T04:36:08.609Z",
"review_opened": "2025-07-03T04:36:08.609Z",
"passed": "2025-07-03T04:36:08.609Z"
},
"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"
}Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.
Authorizations
Path parameters
idstringRequired
Order ID
Query parameters
expandbooleanOptional
Enhanced Payload
Responses
200
OK.
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
404 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
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-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"paid": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"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-07-03T04:36:08.609Z",
"pending_payment": "2025-07-03T04:36:08.609Z",
"in_review": "2025-07-03T04:36:08.609Z",
"complete": "2025-07-03T04:36:08.609Z",
"dispute": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-07-03T04:36:08.609Z",
"review_opened": "2025-07-03T04:36:08.609Z",
"passed": "2025-07-03T04:36:08.609Z"
},
"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"
}Updates an existing order.
Authorizations
Path parameters
idstringRequired
Order ID
Body
requestToBeForgottenbooleanOptionalDefault:
If true, indicates the user who placed the order has requested this order be forgotten.
falseExample: trueupstreamIdstring | nullableOptionalExample:
The upstream identifier.
0916805858Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
401 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /orders/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143
{
"requestToBeForgotten": true,
"upstreamId": "0916805858",
"items": [
{
"id": "242185910336",
"metadata": {
"coupon": "iOS"
}
}
],
"metadata": {
"coupon": "iOS"
}
}{
"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-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"paid": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"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-07-03T04:36:08.609Z",
"pending_payment": "2025-07-03T04:36:08.609Z",
"in_review": "2025-07-03T04:36:08.609Z",
"complete": "2025-07-03T04:36:08.609Z",
"dispute": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-07-03T04:36:08.609Z",
"review_opened": "2025-07-03T04:36:08.609Z",
"passed": "2025-07-03T04:36:08.609Z"
},
"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"
}Refreshes an order so payment.session.stateand/or state can be checked.
Authorizations
Path parameters
idstringRequired
Order ID
Responses
200
OK.
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
404 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /orders/{id}/refresh 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-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"paid": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"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-07-03T04:36:08.609Z",
"pending_payment": "2025-07-03T04:36:08.609Z",
"in_review": "2025-07-03T04:36:08.609Z",
"complete": "2025-07-03T04:36:08.609Z",
"dispute": "2025-07-03T04:36:08.609Z",
"cancelled": "2025-07-03T04:36:08.609Z",
"fulfilled": "2025-07-03T04:36:08.609Z",
"blocked": "2025-07-03T04:36:08.609Z",
"returned": "2025-07-03T04:36:08.609Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-07-03T04:36:08.609Z",
"review_opened": "2025-07-03T04:36:08.609Z",
"passed": "2025-07-03T04:36:08.609Z"
},
"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"
}Retrieves the tax details of each line item in an order. You're required to specify the order's identifier as a path parameter.
Authorizations
Path parameters
idstringRequired
Order ID
Responses
200
OK.
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
404 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /orders/{id}/tax-details HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"orderId": "ord_5823594809",
"items": [
{
"id": "5823594809",
"taxDetails": [
{
"country": "CA",
"region": "MN",
"jurisdictionType": "Country",
"jurisdictionName": "TRANSIT IMPROVEMENT (RAMSEY CO)",
"taxType": "Sales",
"taxSubType": "0",
"taxName": "MN SPECIAL TAX",
"exemptUnit": 0,
"nonTaxableUnit": 0,
"unitOfBasis": "PerCurrencyUnit",
"rate": 0.08,
"effectiveRate": 0.080016,
"taxAmount": 8
}
],
"shippingTaxDetails": [
{
"country": "CA",
"region": "MN",
"jurisdictionType": "Country",
"jurisdictionName": "TRANSIT IMPROVEMENT (RAMSEY CO)",
"taxType": "Sales",
"taxSubType": "0",
"taxName": "MN SPECIAL TAX",
"exemptUnit": 0,
"nonTaxableUnit": 0,
"unitOfBasis": "PerCurrencyUnit",
"rate": 0.08,
"effectiveRate": 0.080016,
"taxAmount": 8
}
]
}
]
}Last updated