Retrieve a disputes report

Retrieve a disputes report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report will be aggregated by this field.

Enum: "website" "gatewayAcquirer" "currency" "bin" "country" "rebillNumber" "retryNumber" "gatewayAccount" "transactionAmount"
periodMonth
required
string

Report month in format YYYY-MM.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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.

Responses
200

Report 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 of objects
Array
aggregationValue
string

Selected aggregation field value (defined by query). It can be, for example, website or country. You define it in aggregationField param in query.

countVisa
integer

Disputes count on Visa.

ratioCountVisa
number <double>

Disputes count / Settled transactions count.

ratioAmountVisa
number <double>

Disputes amount / Settled transactions amount.

countMastercard
integer

Disputes count on Mastercard.

ratioCountMastercard
number <double>

Disputes count / Settled transactions count.

ratioAmountMastercard
number <double>

Disputes amount / Settled transactions amount.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/disputes
Request samples
const params = {
    aggregationField: 'website',
    periodMonth: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getDisputes(params);
Response samples
application/json
{
  • "data": [
    ]
}