Skip to main content
POST
/
api
/
pay
/
{projectId}
/
chargeEvents
/
chargeback
Get Chargeback Details
curl --request POST \
  --url https://localhost:44371/api/pay/{projectId}/chargeEvents/chargeback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "offset": 123,
  "limit": 5000,
  "isForAllProjectsInCompany": true
}
'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Fetches complete chargeback details for dispute management and response preparation. Chargebacks occur when cardholders dispute transactions with their issuing bank. This endpoint provides information needed to respond to disputes including reason codes, deadlines, and required evidence.

​
Input

  • Path Parameter: projectId (guid, required) — Project identifier for authentication.
  • Body: request (ChargebackDetailsQueryRequest, required) — Query request including:
    • chargebackId (string, optional) — Chargeback identifier.
    • transactionId (string, optional) — Transaction identifier.

​
Output

Returns a ChargebackDetailsQueryResponse containing chargeback details or error information.

​
Example Request

POST /api/payment/{projectId}/charge-events/chargeback
Content-Type: application/json
X-API-Key: {your-api-key}

{
  "chargebackId": "CB123456",
  "transactionId": "TX789012"
}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "chargebackId": "CB123456",
  "transactionId": "TX789012",
  "amount": 99.99,
  "reason": "Fraudulent Transaction",
  "reasonCode": "10.4",
  "chargebackDate": "2025-10-15T00:00:00Z",
  "respondByDate": "2025-10-30T23:59:59Z",
  "status": "Pending"
}

​
Errors

  • 404 Not Found — No chargeback exists with the specified ID.
  • 401 Unauthorized — Invalid or missing API key.
  • 403 Forbidden — Chargeback does not belong to specified project.

​
Notes

  • Chargeback disputes must be responded to before respondByDate to avoid automatic acceptance.
  • Chargeback ratios above 1% may trigger payment processor penalties.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
projectId
string<guid>
required

The project identifier for authentication and authorization.

Body

application/json

The chargeback query request containing chargeback ID or transaction reference.

Represents the filters supported when querying CyberSource chargeback details.

​
startDate
string<date-time>
required

Start date for the chargeback search window.

Minimum string length: 1
​
offset
integer<int32>
required

Offset into the result set for pagination.

​
limit
integer<int32>
required

Maximum number of results to return.

Required range: 1 <= x <= 10000
​
isForAllProjectsInCompany
boolean

Indicates whether the search should include every project belonging to the company.

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. Wraps the chargeback query results returned to payment clients.

​
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:
[]