Retrieve disputes

Request

Retrieves a list of all disputes.
Security
SecretApiKey or JWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray 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 ,.

limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
qstring
Use this field to perform a partial search of text fields.
expandstring

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 Embedded resources.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/disputes?filter=string&sort=string&limit=0&offset=0&q=string&expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of disputes successfully retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only
ID of the dispute.
Example:"dp_0YVCE8J5F2DE58FV0S8YASW4HK"
customerIdstring or null, <= 50 charactersread-only
ID of the customer who is disputing a transaction.
Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
transactionIdstring or null, <= 50 characters
ID of the disputed transaction.
Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
currencystring, = 3 characters(CurrencyCode)
Currency code in ISO 4217 format.
Example:"USD"
amountnumber, (double)
Dispute amount.
acquirerReferenceNumberstring or null
Acquirer reference number for the dispute.
caseIdstring or null
Case ID of the dispute.
reasonCodestring or null, <= 255 characters
Code used in the chargeback that describes the reason for the dispute.
reasonDescriptionstring or null, <= 512 charactersread-only
Description of the reason for the dispute.
categorystringread-only
Category of dispute.
Enum:"fraud""authorization""processing-errors""consumer-disputes""uncategorized""bank-return"
typestring
Type of dispute.
Enum:"information-request""first-chargeback""second-chargeback""arbitration""fraud""ethoca-alert""verifi-alert""bank-return""paypal-claim""representment"
statusstring
Status of the dispute.
Enum:"response-needed""under-review""forfeited""won""lost""unknown"
postedTimestring, (date-time)
Date and time when the dispute is posted.
deadlineTimestring 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.
rawResponsestring or nullread-only
Raw response from the payment gateway that processed the disputed transaction.
resolvedTimestring or null, (date-time)read-only
Date and time when the dispute is resolved.
sourcestring or nullread-only
Source of the dispute.
Enum:null"api""manual""sftp""webhook"
revisionintegerread-only
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.
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
_linksArray of objectsread-only
Related links.
_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "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",
    "_links": [ … ],
    "_embedded": { … }
  }
]