Retrieve disputes

Retrieves a list of all disputes.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

q
string

Use this field to perform a partial search of text fields.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

List of disputes successfully retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

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

Currency code in ISO 4217 format.

amount
required
number <double>

Dispute amount.

transactionId
required
string

ID of the disputed transaction.

postedTime
required
string <date-time>

Date and time when the dispute is posted.

type
required
string

Type of dispute.

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

Status of the dispute.

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

Code used in the chargeback that describes the reason for the dispute.

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

ID of the dispute.

customerId
string <= 50 characters

ID of the customer who is disputing a transaction.

acquirerReferenceNumber
string

Acquirer reference number for the dispute.

caseId
string

Case ID of the dispute.

category
string

Category of dispute.

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

Latest date and time by when a merchant must submit a representment for a dispute. If the deadline is missed, the merchant loses the dispute.

rawResponse
string

Raw response from the payment gateway that processed the disputed transaction.

resolvedTime
string <date-time>

Date and time when the dispute is resolved.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "transaction"
object

Embedded objects that are requested by the expand query parameter.

transaction
object
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

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