Retrieve a transaction time dispute report

Retrieves a dispute delay in days report. This report describes the amount of time between a transaction and a dispute.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

Enum: "website" "processor" "currency" "bin" "country" "rebillNumber" "retryNumber" "gatewayAccount" "transactionAmount"
periodStart
required
string <date-time>

Date and time when the report starts.

periodEnd
required
string <date-time>

Date and time when the report ends.

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

Dispute delay data.

Array
aggregationFieldValue
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.

25th
integer

Delay between dispute and transaction time at the 25th percentile.

50th
integer

Delay between dispute and transaction time at the 50th percentile.

75th
integer

Delay between dispute and transaction time at the 75th percentile.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

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