Retrieve a disputes report

Retrieves a disputes report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

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

Report month in YYYY-MM format.

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.

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.

Responses
200

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

Disputes data.

Array
aggregationValue
string

Aggregation field value. This value is defined in the aggregationField parameter by using a query. For example, this value could be: website or country.

countVisa
integer

Total number of disputed Visa transactions.

ratioCountVisa
number <double>

Ratio of the total number of disputed Visa transactions versus the total number of settled Visa transactions.

ratioAmountVisa
number <double>

Ratio of disputed Visa transaction amounts versus settled Visa transaction amounts.

countMastercard
integer

Total number of disputed Mastercard transactions.

ratioCountMastercard
number <double>

Ratio of the total number of disputed Mastercard transactions versus the total number of settled Mastercard transactions.

ratioAmountMastercard
number <double>

Ratio of disputed Mastercard transaction amounts versus settled Mastercard transaction amounts.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/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": [
    ]
}