Orders

Orders handle the purchases of end customers. You can create, retrieve, update, and list all orders.

Returns a list of orders

get

Get all orders.

Authorizations

Query parameters

createdTimestring · date-timeOptional

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the createdTime field equals to this timestamp
gt—return values where the createdTime field is after this timestamp
gte—return values where the createdTime field is after or equal to this timestamp
lt—return values where the createdTime field is before this timestamp
lte—return values where the createdTime field is before or equal to this timestamp

updatedTimestring · date-timeOptional

A filter on the list based on the updatedTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the updatedTime field equals this timestamp
gt—return values where the updatedTime field is after this timestamp
gte—return values where the updatedTime field is after or equal to this timestamp
lt—return values where the updatedTime field is before this timestamp
lte—return values where the updatedTime field is before or equal to this timestamp

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.

totalAmountstringOptional

A filter on the list based on the totalAmount field. The value can be a string or it can be a dictionary with the following options: - eq-return values where the amount field equals to this amount - gt-return values where the amount field is greater than this amount - gte-return values where the amount field is greater than or equal to this amount - lt-return values where the amount field is less than this amount - lte-return values where the amount field is less than or equal to this amount

statestringOptional

Only return objects in the given state

customerIdstringOptional

Only return orders for the given customer

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

in_reviewstring · date-timeOptional

A filter on the list based on the order stateTransitions in_review field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions in_review field equals to this timestamp
gt - return values where the stateTransitions in_review field is after this timestamp
gte - return values where the stateTransitions in_review field is after or equal to this timestamp
lt - return values where the stateTransitions in_review field is before this timestamp
lte - return values where the stateTransitions in_review field is before or equal to this timestamp

pending_paymentstring · date-timeOptional

A filter on the list based on the order stateTransitions pending_payment field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions pending_payment field equals to this timestamp
gt - return values where the stateTransitions pending_payment field is after this timestamp
gte - return values where the stateTransitions pending_payment field is after or equal to this timestamp
lt - return values where the stateTransitions pending_payment field is before this timestamp
lte - return values where the stateTransitions pending_payment field is before or equal to this timestamp

acceptedstring · date-timeOptional

A filter on the list based on the order stateTransitions accepted field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions accepted field equals to this timestamp
gt - return values where the stateTransitions accepted field is after this timestamp
gte - return values where the stateTransitions accepted field is after or equal to this timestamp
lt - return values where the stateTransitions accepted field is before this timestamp
lte - return values where the stateTransitions accepted field is before or equal to this timestamp

blockedstring · date-timeOptional

A filter on the list based on the order stateTransitions blocked field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions blocked field equals to this timestamp
gt - return values where the stateTransitions blocked field is after this timestamp
gte - return values where the stateTransitions blocked field is after or equal to this timestamp
lt - return values where the stateTransitions blocked field is before this timestamp
lte - return values where the stateTransitions blocked field is before or equal to this timestamp

cancelledstring · date-timeOptional

A filter on the list based on the order stateTransitions cancelled field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions cancelled field equals to this timestamp
gt - return values where the stateTransitions cancelled field is after this timestamp
gte - return values where the stateTransitions cancelled field is after or equal to this timestamp
lt - return values where the stateTransitions cancelled field is before this timestamp
lte - return values where the stateTransitions cancelled field is before or equal to this timestamp

fulfilledstring · date-timeOptional

A filter on the list based on the order stateTransitions fulfilled field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions fulfilled field equals to this timestamp
gt - return values where the stateTransitions fulfilled field is after this timestamp
gte - return values where the stateTransitions fulfilled field is after or equal to this timestamp
lt - return values where the stateTransitions fulfilled field is before this timestamp
lte - return values where the stateTransitions fulfilled field is before or equal to this timestamp

completestring · date-timeOptional

A filter on the list based on the order stateTransitions complete field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions complete field equals to this timestamp
gt - return values where the stateTransitions complete field is after this timestamp
gte - return values where the stateTransitions complete field is after or equal to this timestamp
lt - return values where the stateTransitions complete field is before this timestamp
lte - return values where the stateTransitions complete field is before or equal to this timestamp

returnedstring · date-timeOptional

A filter on the list based on the order stateTransitions returned field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the stateTransitions returned field equals to this timestamp
gt - return values where the stateTransitions returned field is after this timestamp
gte - return values where the stateTransitions returned field is after or equal to this timestamp
lt - return values where the stateTransitions returned field is before this timestamp
lte - return values where the stateTransitions returned field is before or equal to this timestamp

fraudStatestringOptional

Only return orders in the given fraudState

fraudStateTransitions.blockedstring · date-timeOptional

A filter on the list based on the order fraudStateTransitions blocked field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the fraudStateTransitions blocked field equals to this timestamp
gt - return values where the fraudStateTransitions blocked field is after this timestamp
gte - return values where the fraudStateTransitions blocked field is after or equal to this timestamp
lt - return values where the fraudStateTransitions blocked field is before this timestamp
lte - return values where the fraudStateTransitions blocked field is before or equal to this timestamp

fraudStateTransitions.review_openedstring · date-timeOptional

A filter on the list based on the order fraudStateTransitions review_opened field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the fraudStateTransitions review_opened field equals to this timestamp
gt - return values where the fraudStateTransitions review_opened field is after this timestamp
gte - return values where the fraudStateTransitions review_opened field is after or equal to this timestamp
lt - return values where the fraudStateTransitions review_opened field is before this timestamp
lte - return values where the fraudStateTransitions review_opened field is before or equal to this timestamp

fraudStateTransitions.passedstring · date-timeOptional

A filter on the list based on the order fraudStateTransitions passed field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq - return values where the fraudStateTransitions passed field equals to this timestamp
gt - return values where the fraudStateTransitions passed field is after this timestamp
gte - return values where the fraudStateTransitions passed field is after or equal to this timestamp
lt - return values where the fraudStateTransitions passed field is before this timestamp
lte - return values where the fraudStateTransitions passed field is before or equal to this timestamp

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",
      "createdTime": "2025-07-07T04:11:45.780Z",
      "customerId": "cus_5774321009",
      "currency": "usd",
      "email": "[email protected]",
      "locale": "en_US",
      "browserIp": "111.111.111.111",
      "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
      "creditAmount": 1,
      "sources": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "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": "??? ??"
        }
      },
      "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": "2025-07-07T04:11:45.780Z",
            "endTime": "2025-07-07T04:11:45.780Z"
          },
          "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-07-07T04:11:45.780Z",
        "pending_payment": "2025-07-07T04:11:45.780Z",
        "in_review": "2025-07-07T04:11:45.780Z",
        "complete": "2025-07-07T04:11:45.780Z",
        "cancelled": "2025-07-07T04:11:45.780Z",
        "fulfilled": "2025-07-07T04:11:45.780Z",
        "blocked": "2025-07-07T04:11:45.780Z",
        "returned": "2025-07-07T04:11:45.780Z"
      },
      "fraudState": "passed",
      "fraudStateTransitions": {
        "blocked": "2025-07-07T04:11:45.780Z",
        "in_review": "2025-07-07T04:11:45.780Z",
        "passed": "2025-07-07T04:11:45.780Z"
      },
      "cancelReason": "fraud",
      "charges": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "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": "2025-07-07T04:11:45.780Z",
              "updatedTime": "2025-07-07T04:11:45.780Z",
              "amount": 1180.26,
              "state": "pending",
              "failureCode": "text",
              "failureMessage": "text"
            }
          ],
          "captures": [
            {
              "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
              "createdTime": "2025-07-07T04:11:45.780Z",
              "updatedTime": "2025-07-07T04:11:45.780Z",
              "amount": 1180.26,
              "state": "pending",
              "failureCode": "text",
              "failureMessage": "text"
            }
          ],
          "captured": false,
          "refunds": [
            {
              "id": "ref_5823594809",
              "createdTime": "2025-07-07T04:11:45.780Z",
              "orderId": "ord_6645940010",
              "invoiceId": "5823594809",
              "currency": "USD",
              "type": "shipping",
              "amount": 9.99,
              "refundedAmount": 9.99,
              "items": [
                [
                  {
                    "type": "shipping",
                    "skuId": "sku_9234276173",
                    "quantity": 1,
                    "amount": 5.95
                  }
                ]
              ],
              "reason": "requested_by_customer",
              "failureReason": "expired_or_canceled_card",
              "state": "created",
              "tokenInformation": {
                "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
                "expiresTime": "2025-07-07T04:11:45.780Z"
              },
              "expiresTime": "2025-07-07T04:11:45.780Z",
              "liveMode": false,
              "metadata": {
                "coupon": "iOS"
              }
            }
          ],
          "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": "2025-07-07T04:11:45.780Z"
    }
  ]
}

Creates a new order

post

Creates a new order.

Authorizations

Body

checkoutIdstringOptional

The unique identifier of a checkout.

Example: 5823594809

customerIdstringOptional

The identifier of the Customer associated with the Checkout.

Example: 5774321009

sourceIdstringOptional

The unique identifier of a Source.

Example: src_a78cfeae-f7ae-4719-8e1c-d05ec04e4d37

currencystringOptional

A three-letter ISO 4217 currency code.

Example: USD

emailstring · emailOptional

The customer's email address.

Example: [email protected]

localestringOptional

A designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.

Example: en-US

applicationIdstringOptional

An arbitrary string identifier that can be used to track the application type.

Example: 68f72e0c-cb7d-48e1-93c8-998668ad0ff4

browserIpstringOptional

The IP address of the browser used by the customer when placing the order.

Example: 111.111.111.111

creditAmountnumber · doubleOptional

Represents the total amount of credit you are extending to the customer.

Example: 10

taxInclusivebooleanOptional

If true, indicates that the prices supplied are tax inclusive.

Example: true

chargeTypestring · enumOptional

Represents the charge type.

Example: merchant_initiatedPossible values:

customerTypestring · enumOptional

The type of customer.

Example: individualPossible values:

upstreamIdstringOptional

The user checkout identifier if it is different from the Digital River checkout identifier.

Example: 7765374748

Responses

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: 1494

{
  "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": "??? ??"
    }
  },
  "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",
  "createdTime": "2025-07-07T04:11:45.780Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "[email protected]",
  "locale": "en_US",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "creditAmount": 1,
  "sources": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
      "createdTime": "2025-07-07T04:11:45.780Z",
      "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": "??? ??"
    }
  },
  "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": "2025-07-07T04:11:45.780Z",
        "endTime": "2025-07-07T04:11:45.780Z"
      },
      "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-07-07T04:11:45.780Z",
    "pending_payment": "2025-07-07T04:11:45.780Z",
    "in_review": "2025-07-07T04:11:45.780Z",
    "complete": "2025-07-07T04:11:45.780Z",
    "cancelled": "2025-07-07T04:11:45.780Z",
    "fulfilled": "2025-07-07T04:11:45.780Z",
    "blocked": "2025-07-07T04:11:45.780Z",
    "returned": "2025-07-07T04:11:45.780Z"
  },
  "fraudState": "passed",
  "fraudStateTransitions": {
    "blocked": "2025-07-07T04:11:45.780Z",
    "in_review": "2025-07-07T04:11:45.780Z",
    "passed": "2025-07-07T04:11:45.780Z"
  },
  "cancelReason": "fraud",
  "charges": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-07-07T04:11:45.780Z",
      "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": "2025-07-07T04:11:45.780Z",
          "updatedTime": "2025-07-07T04:11:45.780Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captures": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "updatedTime": "2025-07-07T04:11:45.780Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captured": false,
      "refunds": [
        {
          "id": "ref_5823594809",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "orderId": "ord_6645940010",
          "invoiceId": "5823594809",
          "currency": "USD",
          "type": "shipping",
          "amount": 9.99,
          "refundedAmount": 9.99,
          "items": [
            [
              {
                "type": "shipping",
                "skuId": "sku_9234276173",
                "quantity": 1,
                "amount": 5.95
              }
            ]
          ],
          "reason": "requested_by_customer",
          "failureReason": "expired_or_canceled_card",
          "state": "created",
          "tokenInformation": {
            "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
            "expiresTime": "2025-07-07T04:11:45.780Z"
          },
          "expiresTime": "2025-07-07T04:11:45.780Z",
          "liveMode": false,
          "metadata": {
            "coupon": "iOS"
          }
        }
      ],
      "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": "2025-07-07T04:11:45.780Z"
}

Gets an order by ID

get

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",
  "createdTime": "2025-07-07T04:11:45.780Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "[email protected]",
  "locale": "en_US",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "creditAmount": 1,
  "sources": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
      "createdTime": "2025-07-07T04:11:45.780Z",
      "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": "??? ??"
    }
  },
  "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": "2025-07-07T04:11:45.780Z",
        "endTime": "2025-07-07T04:11:45.780Z"
      },
      "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-07-07T04:11:45.780Z",
    "pending_payment": "2025-07-07T04:11:45.780Z",
    "in_review": "2025-07-07T04:11:45.780Z",
    "complete": "2025-07-07T04:11:45.780Z",
    "cancelled": "2025-07-07T04:11:45.780Z",
    "fulfilled": "2025-07-07T04:11:45.780Z",
    "blocked": "2025-07-07T04:11:45.780Z",
    "returned": "2025-07-07T04:11:45.780Z"
  },
  "fraudState": "passed",
  "fraudStateTransitions": {
    "blocked": "2025-07-07T04:11:45.780Z",
    "in_review": "2025-07-07T04:11:45.780Z",
    "passed": "2025-07-07T04:11:45.780Z"
  },
  "cancelReason": "fraud",
  "charges": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-07-07T04:11:45.780Z",
      "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": "2025-07-07T04:11:45.780Z",
          "updatedTime": "2025-07-07T04:11:45.780Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captures": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "updatedTime": "2025-07-07T04:11:45.780Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captured": false,
      "refunds": [
        {
          "id": "ref_5823594809",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "orderId": "ord_6645940010",
          "invoiceId": "5823594809",
          "currency": "USD",
          "type": "shipping",
          "amount": 9.99,
          "refundedAmount": 9.99,
          "items": [
            [
              {
                "type": "shipping",
                "skuId": "sku_9234276173",
                "quantity": 1,
                "amount": 5.95
              }
            ]
          ],
          "reason": "requested_by_customer",
          "failureReason": "expired_or_canceled_card",
          "state": "created",
          "tokenInformation": {
            "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
            "expiresTime": "2025-07-07T04:11:45.780Z"
          },
          "expiresTime": "2025-07-07T04:11:45.780Z",
          "liveMode": false,
          "metadata": {
            "coupon": "iOS"
          }
        }
      ],
      "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": "2025-07-07T04:11:45.780Z"
}

Updates an existing order

post

Updates an existing order.

Authorizations

Path parameters

idstringRequired

Order ID

Body

requestToBeForgottenbooleanOptional

If true, indicates the user who placed the order has requested this order be forgotten.

Default: falseExample: true

Responses

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",
  "createdTime": "2025-07-07T04:11:45.780Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "[email protected]",
  "locale": "en_US",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "creditAmount": 1,
  "sources": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
      "createdTime": "2025-07-07T04:11:45.780Z",
      "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": "??? ??"
    }
  },
  "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": "2025-07-07T04:11:45.780Z",
        "endTime": "2025-07-07T04:11:45.780Z"
      },
      "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-07-07T04:11:45.780Z",
    "pending_payment": "2025-07-07T04:11:45.780Z",
    "in_review": "2025-07-07T04:11:45.780Z",
    "complete": "2025-07-07T04:11:45.780Z",
    "cancelled": "2025-07-07T04:11:45.780Z",
    "fulfilled": "2025-07-07T04:11:45.780Z",
    "blocked": "2025-07-07T04:11:45.780Z",
    "returned": "2025-07-07T04:11:45.780Z"
  },
  "fraudState": "passed",
  "fraudStateTransitions": {
    "blocked": "2025-07-07T04:11:45.780Z",
    "in_review": "2025-07-07T04:11:45.780Z",
    "passed": "2025-07-07T04:11:45.780Z"
  },
  "cancelReason": "fraud",
  "charges": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-07-07T04:11:45.780Z",
      "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": "2025-07-07T04:11:45.780Z",
          "updatedTime": "2025-07-07T04:11:45.780Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captures": [
        {
          "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "updatedTime": "2025-07-07T04:11:45.780Z",
          "amount": 1180.26,
          "state": "pending",
          "failureCode": "text",
          "failureMessage": "text"
        }
      ],
      "captured": false,
      "refunds": [
        {
          "id": "ref_5823594809",
          "createdTime": "2025-07-07T04:11:45.780Z",
          "orderId": "ord_6645940010",
          "invoiceId": "5823594809",
          "currency": "USD",
          "type": "shipping",
          "amount": 9.99,
          "refundedAmount": 9.99,
          "items": [
            [
              {
                "type": "shipping",
                "skuId": "sku_9234276173",
                "quantity": 1,
                "amount": 5.95
              }
            ]
          ],
          "reason": "requested_by_customer",
          "failureReason": "expired_or_canceled_card",
          "state": "created",
          "tokenInformation": {
            "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
            "expiresTime": "2025-07-07T04:11:45.780Z"
          },
          "expiresTime": "2025-07-07T04:11:45.780Z",
          "liveMode": false,
          "metadata": {
            "coupon": "iOS"
          }
        }
      ],
      "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": "2025-07-07T04:11:45.780Z"
}

PreviousInvoices NextPayouts

Last updated 8 months ago