Retrieve a list of disputes

Retrieve a list of disputes.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

q
string

The partial search of the text fields.

expand
string

Expand a response to get a full related object included inside of the _embedded path in the response. It accepts a comma-separated list of objects to expand. See the expand guide for more info.

Responses
200

A list of disputes was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array
currency
required
string = 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

transactionId
required
string

The dispute's transaction ID.

postedTime
required
string <date-time>

Dispute posted time.

type
required
string

The dispute's type.

Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert"
status
required
string

The dispute's status.

Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown"
reasonCode
required
string

The dispute's reason code.

Enum: "1000" "10.1" "10.2" "10.3" "10.4" "10.5" "11.1" "11.2" "11.3" "12" … 156 more
id
string <= 50 characters

The dispute identifier string.

customerId
string

The dispute's customer ID.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

category
string

The dispute's category.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
deadlineTime
string <date-time>

Dispute deadline time.

rawResponse
string

Dispute raw response from gateway.

resolvedTime
string <date-time>

Dispute resolved time.

createdTime
string <date-time>

Dispute created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of Self (object) or TransactionLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
Array of TransactionEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Array (non-empty)
Any of:

Transaction object.

object (Transaction)
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/disputes
Request samples
$disputes = $client->disputes()->search([
    'filter' => 'transactionId:testId',
]);
Response samples
application/json
[
  • {
    }
]