Charges

The Charges resource represents a financial transaction where a specific amount is billed to a customer's payment method. This encompasses the full lifecycle of a charge, including creation, possible disputes, and eventual resolution. Understanding how to use the Charges resource is crucial for managing payments, handling potential chargebacks, and ensuring accurate financial reporting. For more details on related concepts, see the , , and sections. For details on the distinction between charge refunds and refunds, refer to .

Previous2021-12-13 NextCharge basics

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": "2018-04-25T20:36:00Z",
  "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": "2018-04-25T20:36:00Z",
      "updatedTime": "2018-04-25T20:36:00Z",
      "amount": 1180.26,
      "failureCode": "text",
      "failureMessage": "text",
      "state": "pending"
    }
  ],
  "captures": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2018-04-25T20:36:00Z",
      "updatedTime": "2018-04-25T20:36:00Z",
      "amount": 1180.26,
      "failureCode": "text",
      "failureMessage": "text",
      "state": "pending"
    }
  ],
  "refunds": [
    {
      "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
      "createdTime": "2018-04-25T20:36:00Z",
      "updatedTime": "2018-04-25T20:36:00Z",
      "amount": 1180.26,
      "failureCode": "text",
      "failureMessage": "text",
      "state": "pending"
    }
  ]
}

OK.