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 charges, charge refunds, and refunds sections. For details on the distinction between charge refunds and refunds, refer to How refunds differ from charge refunds.

Gets a charge by ID

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Charge ID

Responses

200

OK.

application/json

idstringRead-onlyOptional

The unique identifier of the charge.

Example: a6809a63-e6a9-4016-abbc-f33d19fccb5b

createdTimestring · date-timeRead-onlyOptional

The time when the charge was created.

Example: 2018-04-25T20:36:00Z

currencystringOptional

A three-letter ISO 4217 currency code.

Example: USD

amountnumber · doubleOptional

An amount representing how much is to be to charged.

Example: 1180.26

statestring · enumOptional

The state of the charge.

Example: pendingPossible values:

orderIdstringOptional

The identifier of the associated order.

Example: 9986340012

sourceIdstringOptional

The identifier of the source.

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 · enumOptional

The type of charge.

Possible values:

liveModebooleanOptional

Has the value true if the object exists in live mode and the value false if 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
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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