Charges

The resource contains the details of a charge.

Previous2020-09-30 NextCheckouts

Last updated 3 months ago

Gets a charge by ID

Retrieves the details of a Charge by supplying its unique identifier.

get

/charges/{id}

Authorizations

Path parameters

idstringrequired

Charge ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/charges/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
  "createdTime": "2025-02-23T03:07:20.902Z",
  "currency": "USD",
  "amount": 1180.26,
  "orderId": "9986340012",
  "sourceId": "9986340012",
  "failureCode": "a failure code",
  "failureMessage": "a failure message",
  "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
  "captured": false,
  "refunded": false,
  "liveMode": true,
  "state": "pending",
  "type": "customer_initiated",
  "cancels": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-02-23T03:07:20.902Z",
      "updatedTime": "2025-02-23T03:07:20.902Z",
      "amount": 1180.26,
      "failureCode": "text",
      "failureMessage": "text",
      "state": "pending"
    }
  ],
  "captures": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2025-02-23T03:07:20.902Z",
      "updatedTime": "2025-02-23T03:07:20.902Z",
      "amount": 1180.26,
      "failureCode": "text",
      "failureMessage": "text",
      "state": "pending"
    }
  ],
  "refunds": [
    {
      "id": "ref_5823594809",
      "createdTime": "2025-02-23T03:07:20.902Z",
      "orderId": "ord_6645940010",
      "invoiceId": "5823594809",
      "currency": "USD",
      "amount": 9.99,
      "refundedAmount": 9.99,
      "reason": "requested_by_customer",
      "failureReason": "expired_or_canceled_card",
      "tokenInformation": {
        "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709",
        "expiresTime": "2025-02-23T03:07:20.902Z"
      },
      "expiresTime": "2025-02-23T03:07:20.902Z",
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "type": "shipping",
      "state": "created",
      "items": [
        [
          {
            "type": "shipping",
            "skuId": "sku_9234276173",
            "quantity": 1,
            "amount": 5.95
          }
        ]
      ]
    }
  ]
}

OK.