logo

Retrieve a DCC markup report

Retrieve a DCC markup report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

Enum: "day" "month" "bin" "country" "baseCurrency" "quoteCurrency"
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
aggregationValue
string

Value by which the report provides aggregated data. The date values are displayed as following: Day: YYYY-MM-DD; Month: YYYY-MM.

selectedCount
integer

Number of selected offers in the aggregation.

selectedSum
number <double>

Amount of selected offers in the aggregation.

rejectedCount
integer

Number of rejected offers in the aggregation.

rejectedSum
number <double>

Amount of rejected offers in the aggregation.

unknownCount
integer

Number of offers in the aggregation which weren't selected nor rejected.

unknownSum
number <double>

Amount of offers in the aggregation which weren't selected nor rejected.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/dcc-markup
Request samples
const params = {
    aggregationField: 'day',
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    filter: `gatewayAccounts:f9b4fa10-df1d-48a3-85b3-ff6bd7ce0ed2; \
            transactionResult:approved,canceled,declined,unknown`,
    tz: 0
};
const report = await api.reports.getDccMarkup(params);
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Retrieve a disputes report