Developer docs
/
Rebilly API
/
Disputes
/
Retrieve disputes

Retrieve disputes

Retrieves a list of all disputes.

SecurityAPI Key: SecretApiKey or HTTP: 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 -. Multiple fields can be sorted by separating each with ,.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

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.

get
/disputes
Request samples
$disputes = $client->disputes()->search([
    'filter' => 'transactionId:testId',
]);
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
id
string <= 50 characters

ID of the dispute.

customerId
string or null <= 50 characters

ID of the customer who is disputing a transaction.

transactionId
string or null <= 50 characters

ID of the disputed transaction.

currency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

amount
number <double>

Dispute amount.

acquirerReferenceNumber
string or null

Acquirer reference number for the dispute.

caseId
string or null

Case ID of the dispute.

reasonCode
string or null <= 255 characters

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

reasonDescription
string or null <= 512 characters

Description of the reason for the dispute.

category
string

Category of dispute.

Enum: "fraud" "authorization" "processing-errors" "consumer-disputes" "uncategorized" "bank-return"
type
string

Type of dispute.

Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" "bank-return" "paypal-claim"
status
string

Status of the dispute.

Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown"
postedTime
string <date-time>

Date and time when the dispute is posted.

deadlineTime
string or null <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 or null

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

resolvedTime
string or null <date-time>

Date and time when the dispute is resolved.

source
string or null

Source of the dispute.

Enum: null "api" "manual" "sftp" "webhook"
revision
integer

Number of times the dispute data has been modified.

Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.

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.

object

Embedded objects that are requested by the expand query parameter.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"id": "dp_0YVCE8J5F2DE58FV0S8YASW4HK",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
"currency": "USD",
"amount": 0.1,
"acquirerReferenceNumber": "string",
"caseId": "string",
"reasonCode": "string",
"reasonDescription": "string",
"category": "fraud",
"type": "information-request",
"status": "response-needed",
"postedTime": "2019-08-24T14:15:22Z",
"deadlineTime": "2019-08-24T14:15:22Z",
"rawResponse": "string",
"resolvedTime": "2019-08-24T14:15:22Z",
"source": null,
"revision": 0,
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",


}
]