logo

Retrieve a dispute delays in days report

Retrieve a dispute delays in days report, how much time between a. transaction and a dispute.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report will be aggregated by this field.

Enum: "website" "processor" "currency" "bin" "country" "rebillNumber" "retryNumber" "gatewayAccount" "transactionAmount"
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

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
aggregationFieldValue
string

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

25th
integer

25th percentile.

50th
integer

50th percentile.

75th
integer

75th percentile.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/transactions-time-dispute
Request samples
const params = {
    aggregationField: 'website',
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getTransactionsTimeDispute(params);
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Retrieve a transactions report