Skip to main content
GET
/
api
/
adm
/
reports
/
chargebacks
Get Chargeback Report
curl --request GET \
  --url https://localhost:44371/api/adm/reports/chargebacks \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Generates a report of disputed transactions (chargebacks) for analysis and resolution. Chargebacks occur when cardholders dispute transactions with their bank, requiring merchants to provide evidence or accept the reversal. Helps identify chargeback patterns and monitor ratios.

​
Input

  • Query Parameters: request (ChargebackReportQueryRequest) — Filtering options including:
    • startDate (datetime, required) — Report start date.
    • endDate (datetime, required) — Report end date.
    • companyId (guid, optional) — Filter by company identifier.
    • projectId (guid, optional) — Filter by project identifier.
    • status (string, optional) — Filter by chargeback status.

​
Output

Returns a ChargebackReportQueryResponse containing chargeback data or an empty list if none found.

​
Example Request

GET /api/admin/reports/chargebacks?startDate=2025-01-01&endDate=2025-01-31&companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "chargebacks": [
    {
      "transactionId": "TX123456",
      "chargebackDate": "2025-01-15T10:30:00Z",
      "amount": 99.99,
      "reason": "Fraudulent Transaction",
      "status": "Pending",
      "dueDate": "2025-01-30T23:59:59Z"
    }
  ],
  "totalCount": 1,
  "totalAmount": 99.99
}

​
Errors

  • 400 Bad Request — Missing required date range, invalid filter parameters, or date range exceeds maximum (typically 90 days).
  • 401 Unauthorized — Missing or invalid authentication token.
  • 404 Not Found — No chargebacks exist matching specified filters.

​
Notes

  • Report data updated in real-time as chargebacks reported by payment processors.
  • Empty results return success with empty chargebacks array.
  • Chargeback ratios above 1 percent may trigger payment processor penalties.
  • Disputes must be responded to within dueDate to avoid automatic acceptance.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
CompanyId
string<guid>
​
StartDate
string<date-time>
​
EndDate
string<date-time>
​
ChargebackReportDateType
enum<string>
Available options:
DateCreated,
CaseTime

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]