Sign in

v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
Chargebacks

View chargeback summary

Returns a summary of all chargebacks within the default or specified date range.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

<div style="display:none;">

Request parameters

  • endDate
  • startDate

Response parameters

  • newChargebacksCount
  • newChargebacksTotal
  • wonChargebacksCount
  • wonChargebacksTotal
  • representmentsCount
  • representmentsTotal
</div>
get/chargeback/v3/summary

Query parameters

startDatestring
Example:2022-02-13

The start date. The default start date is 30 days prior to today's date. Format: YYYY-MM-DD

endDatestring
Example:2022-02-19

The end date. The default end date is today's date. Format: YYYY-MM-DD

Response

Success

newChargebacksCountinteger

The total number of new chargebacks.

newChargebacksTotalnumber

The total amount of all new chargebacks.

wonChargebacksCountinteger

The total number of won chargebacks.

wonChargebacksTotalnumber

The total amount of all won chargebacks.

representmentsCountinteger

The total number of chargebacks in representment status.

representmentsTotalnumber

The total amount of all chargebacks in representment status.

Example response

{
  "newChargebacksCount": 5,
  "newChargebacksTotal": 450.87,
  "wonChargebacksCount": 7,
  "wonChargebacksTotal": 558.7,
  "representmentsCount": 1,
  "representmentsTotal": 38.03
}