/
Retrieve a disputes repor...

Retrieve a disputes report
Experimental

Request

Retrieves a disputes report.

Security
SecretApiKey or JWT
Query
aggregationFieldstring

Report aggregation field.

Default:"website"
Enum:"website""gatewayAcquirer""currency""bin""country""rebillNumber""retryNumber""gatewayAccount"
periodMonthstring^\d{4}-(0[1-9]|1[0-2])$

Report month in YYYY-MM format. If no value is provided, current month is used.

limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

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.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/disputes?aggregationField=website&periodMonth=string&limit=1000&offset=1000&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Headers
Pagination-Totalinteger

Total number of items.

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
dataArray of objects

Disputes data.

Response
{
  "data": [
    { … }
  ]
}