logo

Retrieve a DCC markup report

Retrieves a Dynamic Currency Conversion (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 <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

Aggregation data.

Array
aggregationValue
string

Value by which the report provides aggregated data. Date values are displayed as follows:

  • 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 are not selected nor rejected.

unknownSum
number <double>

Amount of offers in the aggregation which are not selected nor rejected.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/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