Charges

The Charge resource contains the details of a charge.

Gets a charge by ID

get

Retrieves the details of a charge. You must supply the unique identifier of the charge.

Path parameters

idstringRequired

Charge ID

Responses

200

OK.

application/json

idstringRead-onlyOptional

Unique identifier of the charge.

Example: a6809a63-e6a9-4016-abbc-f33d19fccb5b

createdTimestring · date-timeRead-onlyOptional

Time when the charge was created.

currencystringOptional

Three-letter ISO currency code.

Example: USD

amountnumber · doubleOptional

Amount representing how much to charge. The minimum amount is $0.50 US or equivalent in charge currency.

Example: 1180.26

statestring · enumOptional

The status of the charge, one of pending, succeeded or failed.

Example: pendingPossible values:

orderIdstringOptional

ID of the order this charge is for if one exists.

Example: 9986340012

sourceIdstringOptional

ID of the source used to create this charge.

Example: 9986340012

failureCodestringOptional

Error code identifying reason for charge failure.

Example: a failure code

failureMessagestringOptional

Error message describing reason for charge failure.

Example: a failure message

paymentSessionIdstringOptional

Tracks the process of collecting a payment.

Example: 8cecaa32-f692-44cc-b103-4cf24dc93913

capturedbooleanOptional

Indicates if the charge has been captured.

Example: false

refundedbooleanOptional

Indicates if the charge has been refunded.

Example: false

typestring · enumOptionalPossible values:

liveModebooleanOptional

Has the value true if the object exists in live mode and the value false it the object exists in test mode.

Example: true

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

/charges/{id}

HTTPcURLJavaScriptPython

GET /charges/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
  "createdTime": "2026-03-10T05:00:50.901Z",
  "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": "2026-03-10T05:00:50.901Z",
      "updatedTime": "2026-03-10T05:00:50.901Z",
      "amount": 1180.26,
      "state": "pending",
      "failureCode": "text",
      "failureMessage": "text"
    }
  ],
  "captures": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2026-03-10T05:00:50.901Z",
      "updatedTime": "2026-03-10T05:00:50.901Z",
      "amount": 1180.26,
      "state": "pending",
      "failureCode": "text",
      "failureMessage": "text"
    }
  ],
  "captured": false,
  "refunds": [
    {
      "id": "ref_5823594809",
      "createdTime": "2026-03-10T05:00:50.901Z",
      "orderId": "ord_6645940010",
      "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": "2026-03-10T05:00:50.901Z"
      },
      "expiresTime": "2026-03-10T05:00:50.901Z",
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      }
    }
  ],
  "refunded": false,
  "type": "customer_initiated",
  "liveMode": true
}