Orders
Orders handle the purchases of end customers. You can create, retrieve, update, and list all orders.
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": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"customerId": "cus_5774321009",
"currency": "usd",
"email": "[email protected]",
"locale": "en_US",
"browserIp": "111.111.111.111",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"creditAmount": 1,
"chargeType": "merchant_initiated",
"sources": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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"
}
},
"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"
},
"payCo": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"payCo": {}
},
"flow": "standard",
"state": "chargeable",
"metadata": {
"coupon": "iOS"
},
"customerId": "5823594809",
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"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": "??? ??"
}
},
"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",
"subscriptionInfo": {
"freeTrial": true,
"autoRenewal": true,
"terms": "Please accept these terms.",
"subscriptionId": "665430999",
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"startTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2020,
"monthValue": 5,
"dayOfMonth": 21,
"hour": 0,
"minute": 0,
"second": 0,
"dayOfWeek": "THURSDAY",
"dayOfYear": 142,
"month": "MAY"
},
"endTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2021,
"monthValue": 5,
"dayOfMonth": 20,
"hour": 11,
"minute": 59,
"second": 59,
"dayOfWeek": "THURSDAY",
"dayOfYear": 140,
"month": "MAY"
}
},
"fees": {
"details": [
{
"type": "battery",
"perUnitAmount": 1.5,
"id": "asdkj1h239lkj123j9123"
}
],
"amount": 4.5,
"taxAmount": 1.2
},
"quantity": 2,
"amount": 18.58,
"availableToRefundAmount": 18.58,
"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": "??? ??"
}
},
"metadata": {
"coupon": "iOS"
}
}
],
"invoicePDFs": [
{
"id": "text",
"url": "text"
}
],
"creditMemoPDFs": [
{
"id": "text",
"url": "text"
}
],
"requestToBeForgotten": true,
"shippingChoice": {
"amount": 5.95,
"taxAmount": 0.1,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground"
},
"state": "created",
"stateTransitions": {
"accepted": "2025-08-30T08:25:07.362Z",
"pending_payment": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"complete": "2025-08-30T08:25:07.362Z",
"cancelled": "2025-08-30T08:25:07.362Z",
"fulfilled": "2025-08-30T08:25:07.362Z",
"blocked": "2025-08-30T08:25:07.362Z",
"returned": "2025-08-30T08:25:07.362Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"passed": "2025-08-30T08:25:07.362Z"
},
"cancelReason": "fraud",
"charges": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captures": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captured": false,
"refunds": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"refunded": false,
"type": "customer_initiated",
"liveMode": true
}
],
"paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
"liveMode": true,
"metadata": {
"coupon": "iOS"
},
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"customerType": "individual",
"upstreamId": "0916805858",
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 37,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
}
}
]
}Creates a new 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.
USDlocalestringOptionalExample:
A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
en-USapplicationIdstringOptionalExample:
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.111creditAmountnumber · doubleOptionalExample:
Represents the total amount of credit you are extending to the customer.
10taxInclusivebooleanOptionalExample:
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:
The user checkout identifier if it is different from the Digital River checkout identifier.
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: 1826
{
"checkoutId": "5823594809",
"customerId": "5774321009",
"sourceId": "src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37",
"currency": "USD",
"email": "[email protected]",
"locale": "en-US",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"browserIp": "111.111.111.111",
"creditAmount": 10,
"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": "??? ??"
}
},
"shippingChoice": {
"amount": 5.95,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground"
},
"discount": {
"amountOff": 5.95,
"percentOff": 100
},
"items": [
{
"skuId": "5823594809",
"price": 9.99,
"discount": {
"quantity 1": null,
"amountOff": 10
}
},
{
"skuId": "5823594809",
"price": 9.99,
"quantity": 2,
"discount": {
"quantity 2": null,
"amountOff": 10
}
},
{
"skuId": "9234276173",
"price": 9.99,
"quantity": 2
}
],
"shippingDiscount": {
"amountOff": 5.95,
"percentOff": 100
},
"taxInclusive": true,
"chargeType": "merchant_initiated",
"customerType": "individual",
"metadata": {
"coupon": "iOS"
},
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"upstreamId": "7765374748"
}{
"id": "ord_5823594809",
"checkoutId": "5823594809",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"customerId": "cus_5774321009",
"currency": "usd",
"email": "[email protected]",
"locale": "en_US",
"browserIp": "111.111.111.111",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"creditAmount": 1,
"chargeType": "merchant_initiated",
"sources": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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"
}
},
"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"
},
"payCo": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"payCo": {}
},
"flow": "standard",
"state": "chargeable",
"metadata": {
"coupon": "iOS"
},
"customerId": "5823594809",
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"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": "??? ??"
}
},
"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",
"subscriptionInfo": {
"freeTrial": true,
"autoRenewal": true,
"terms": "Please accept these terms.",
"subscriptionId": "665430999",
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"startTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2020,
"monthValue": 5,
"dayOfMonth": 21,
"hour": 0,
"minute": 0,
"second": 0,
"dayOfWeek": "THURSDAY",
"dayOfYear": 142,
"month": "MAY"
},
"endTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2021,
"monthValue": 5,
"dayOfMonth": 20,
"hour": 11,
"minute": 59,
"second": 59,
"dayOfWeek": "THURSDAY",
"dayOfYear": 140,
"month": "MAY"
}
},
"fees": {
"details": [
{
"type": "battery",
"perUnitAmount": 1.5,
"id": "asdkj1h239lkj123j9123"
}
],
"amount": 4.5,
"taxAmount": 1.2
},
"quantity": 2,
"amount": 18.58,
"availableToRefundAmount": 18.58,
"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": "??? ??"
}
},
"metadata": {
"coupon": "iOS"
}
}
],
"invoicePDFs": [
{
"id": "text",
"url": "text"
}
],
"creditMemoPDFs": [
{
"id": "text",
"url": "text"
}
],
"requestToBeForgotten": true,
"shippingChoice": {
"amount": 5.95,
"taxAmount": 0.1,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground"
},
"state": "created",
"stateTransitions": {
"accepted": "2025-08-30T08:25:07.362Z",
"pending_payment": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"complete": "2025-08-30T08:25:07.362Z",
"cancelled": "2025-08-30T08:25:07.362Z",
"fulfilled": "2025-08-30T08:25:07.362Z",
"blocked": "2025-08-30T08:25:07.362Z",
"returned": "2025-08-30T08:25:07.362Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"passed": "2025-08-30T08:25:07.362Z"
},
"cancelReason": "fraud",
"charges": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captures": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captured": false,
"refunds": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"refunded": false,
"type": "customer_initiated",
"liveMode": true
}
],
"paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
"liveMode": true,
"metadata": {
"coupon": "iOS"
},
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"customerType": "individual",
"upstreamId": "0916805858",
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 37,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
}
}Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.
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} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "ord_5823594809",
"checkoutId": "5823594809",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"customerId": "cus_5774321009",
"currency": "usd",
"email": "[email protected]",
"locale": "en_US",
"browserIp": "111.111.111.111",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"creditAmount": 1,
"chargeType": "merchant_initiated",
"sources": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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"
}
},
"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"
},
"payCo": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"payCo": {}
},
"flow": "standard",
"state": "chargeable",
"metadata": {
"coupon": "iOS"
},
"customerId": "5823594809",
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"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": "??? ??"
}
},
"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",
"subscriptionInfo": {
"freeTrial": true,
"autoRenewal": true,
"terms": "Please accept these terms.",
"subscriptionId": "665430999",
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"startTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2020,
"monthValue": 5,
"dayOfMonth": 21,
"hour": 0,
"minute": 0,
"second": 0,
"dayOfWeek": "THURSDAY",
"dayOfYear": 142,
"month": "MAY"
},
"endTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2021,
"monthValue": 5,
"dayOfMonth": 20,
"hour": 11,
"minute": 59,
"second": 59,
"dayOfWeek": "THURSDAY",
"dayOfYear": 140,
"month": "MAY"
}
},
"fees": {
"details": [
{
"type": "battery",
"perUnitAmount": 1.5,
"id": "asdkj1h239lkj123j9123"
}
],
"amount": 4.5,
"taxAmount": 1.2
},
"quantity": 2,
"amount": 18.58,
"availableToRefundAmount": 18.58,
"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": "??? ??"
}
},
"metadata": {
"coupon": "iOS"
}
}
],
"invoicePDFs": [
{
"id": "text",
"url": "text"
}
],
"creditMemoPDFs": [
{
"id": "text",
"url": "text"
}
],
"requestToBeForgotten": true,
"shippingChoice": {
"amount": 5.95,
"taxAmount": 0.1,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground"
},
"state": "created",
"stateTransitions": {
"accepted": "2025-08-30T08:25:07.362Z",
"pending_payment": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"complete": "2025-08-30T08:25:07.362Z",
"cancelled": "2025-08-30T08:25:07.362Z",
"fulfilled": "2025-08-30T08:25:07.362Z",
"blocked": "2025-08-30T08:25:07.362Z",
"returned": "2025-08-30T08:25:07.362Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"passed": "2025-08-30T08:25:07.362Z"
},
"cancelReason": "fraud",
"charges": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captures": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captured": false,
"refunds": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"refunded": false,
"type": "customer_initiated",
"liveMode": true
}
],
"paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
"liveMode": true,
"metadata": {
"coupon": "iOS"
},
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"customerType": "individual",
"upstreamId": "0916805858",
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 37,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
}
}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: trueResponses
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: 57
{
"requestToBeForgotten": true,
"metadata": {
"coupon": "iOS"
}
}{
"id": "ord_5823594809",
"checkoutId": "5823594809",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"customerId": "cus_5774321009",
"currency": "usd",
"email": "[email protected]",
"locale": "en_US",
"browserIp": "111.111.111.111",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"creditAmount": 1,
"chargeType": "merchant_initiated",
"sources": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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"
}
},
"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"
},
"payCo": {
"redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
"returnUrl": "https://mypage.com/success",
"payCo": {}
},
"flow": "standard",
"state": "chargeable",
"metadata": {
"coupon": "iOS"
},
"customerId": "5823594809",
"paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
"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": "??? ??"
}
},
"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",
"subscriptionInfo": {
"freeTrial": true,
"autoRenewal": true,
"terms": "Please accept these terms.",
"subscriptionId": "665430999",
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"startTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2020,
"monthValue": 5,
"dayOfMonth": 21,
"hour": 0,
"minute": 0,
"second": 0,
"dayOfWeek": "THURSDAY",
"dayOfYear": 142,
"month": "MAY"
},
"endTime": {
"offset": {
"totalSeconds": -18000,
"id": "-05:00",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2021,
"monthValue": 5,
"dayOfMonth": 20,
"hour": 11,
"minute": 59,
"second": 59,
"dayOfWeek": "THURSDAY",
"dayOfYear": 140,
"month": "MAY"
}
},
"fees": {
"details": [
{
"type": "battery",
"perUnitAmount": 1.5,
"id": "asdkj1h239lkj123j9123"
}
],
"amount": 4.5,
"taxAmount": 1.2
},
"quantity": 2,
"amount": 18.58,
"availableToRefundAmount": 18.58,
"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": "??? ??"
}
},
"metadata": {
"coupon": "iOS"
}
}
],
"invoicePDFs": [
{
"id": "text",
"url": "text"
}
],
"creditMemoPDFs": [
{
"id": "text",
"url": "text"
}
],
"requestToBeForgotten": true,
"shippingChoice": {
"amount": 5.95,
"taxAmount": 0.1,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground"
},
"state": "created",
"stateTransitions": {
"accepted": "2025-08-30T08:25:07.362Z",
"pending_payment": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"complete": "2025-08-30T08:25:07.362Z",
"cancelled": "2025-08-30T08:25:07.362Z",
"fulfilled": "2025-08-30T08:25:07.362Z",
"blocked": "2025-08-30T08:25:07.362Z",
"returned": "2025-08-30T08:25:07.362Z"
},
"fraudState": "passed",
"fraudStateTransitions": {
"blocked": "2025-08-30T08:25:07.362Z",
"in_review": "2025-08-30T08:25:07.362Z",
"passed": "2025-08-30T08:25:07.362Z"
},
"cancelReason": "fraud",
"charges": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"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": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captures": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"captured": false,
"refunds": [
{
"id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
"createdTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 36,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
},
"amount": 1180.26,
"state": "pending",
"failureCode": "text",
"failureMessage": "text"
}
],
"refunded": false,
"type": "customer_initiated",
"liveMode": true
}
],
"paymentSessionId": "ps_8cecaa32-f692-44cc-b103-4cf24dc93913",
"liveMode": true,
"metadata": {
"coupon": "iOS"
},
"sellingEntity": {
"id": "C5_INC-ENTITY",
"name": "DR globalTech Inc."
},
"purchaseLocation": {
"country": "US",
"state": "MN",
"postalCode": "55364"
},
"customerType": "individual",
"upstreamId": "0916805858",
"updatedTime": {
"offset": {
"totalSeconds": 0,
"id": "Z",
"rules": {
"fixedOffset": true,
"transitions": [],
"transitionRules": []
}
},
"nano": 0,
"year": 2018,
"monthValue": 4,
"dayOfMonth": 25,
"hour": 20,
"minute": 37,
"second": 0,
"dayOfWeek": "WEDNESDAY",
"dayOfYear": 115,
"month": "APRIL"
}
}Last updated