| business_private |
query |
Filter transactions by business (0 = business) and private (1 = private). |
No |
integer |
| card_scheme |
query |
Filter by card scheme. Available schemes: [AMERICAN EXPRESS, ATM, BANKCARD, CHINA UNION PAY, CHJONES FUEL CARD, DANKORT, DINERS CLUB, DISCOVER, ELO, GE CAPITAL, JCB, LASER, LOYALTY CARD, MAESTRO, MASTERCARD, PHH FUEL CARD, PLATIMA, PPT, PRIVATE LABEL, RBS, RED FUEL CARD, SOLO, UK FUEL CARD, VISA] |
No |
[ string ] |
| currency |
query |
Set ISO-4217 currency code. Default currency code = EUR). Example: DKK |
No |
string |
| date_range_end |
query |
End date in a range of dates Minimum value: 1 January four years ago Maximum value: Current date Example: YYYY-MM-DD |
No |
date |
| date_range_start |
query |
Initial date in a range of dates Minimum value: 1 January four years ago Maximum value: Current date Example: YYYY-MM-DD |
No |
date |
| domestic_international |
query |
Filter cardholder transactions by domestic (0 = domestic) or international (1 = international). |
No |
integer |
| estimated_residence_country_a3 |
query |
Filter by cardholder ISO-A3 country code. Example: DNK |
No |
[ string ] |
| estimated_residence_municipality_code |
query |
Filter by customer municipality code. Example: 43 |
No |
[ integer ] |
| estimated_residence_region_code |
query |
Filter by cardholder region. Example: 3 |
No |
[ integer ] |
| group_by |
query |
Group output by one or more of the following values. Possible values: transaction_year, transaction_quarter, transaction_month, transaction_week, transaction_date, transaction_day, transaction_hour, group_name, company_name, vat_code, outlet_country, outlet_region, outlet_municipality, outlet_zipcode, outlet_id, outlet_name, outlet_mcc, online_physical, terminal_id, is_refund, issuer_country, domestic_international, estimated_residence_municipality, estimated_residence_region, estimated_residence_country, is_municipality_local, business_private, is_regional_local, business_private, card_scheme. |
No |
[ string ] |
| hour_range_end |
query |
End hour in a range of hours. Minimum: 0. Maximum : 23. Example: 20 |
No |
integer |
| hour_range_start |
query |
Initial hour in a range of hours. Minimum: 0. Maximum : 23. Example: 5 |
No |
integer |
| is_municipality_local |
query |
Filter transactions by the cardholder estimated residence being either in the merchant municipality (1) or outside the merchant municipality (0). |
No |
integer |
| is_non_local |
query |
Filter transactions by cardholder estimated residence region not in merchant region (1) or cardholder estimated residence region in merchant region (0). |
No |
integer |
| is_refund |
query |
Filter transactions by regular (0 = regular) and refund (1 = refund). |
No |
integer |
| is_regional_local |
query |
Filter transactions by cardholder estimated residence region not in merchant region (0) or cardholder estimated residence region in merchant region (1). |
No |
integer |
| issuer_country_a3 |
query |
Filter by issuer ISO-A3 country code. Example: DNK |
No |
[ string ] |
| month_range_end |
query |
End month in a range of months. Example: 10 |
No |
integer |
| month_range_start |
query |
Initial month in a range of months Example: 5 |
No |
integer |
| online_physical |
query |
Filter transactions by online (0 = e-commerce) and physical store (1 = POS). |
No |
integer |
| outlet_country_a3 |
query |
Filter by outlet ISO-A3 country code. Example: DNK |
No |
[ string ] |
| outlet_id |
query |
Filter by outlet ID. Example: 99 |
No |
[ integer ] |
| outlet_mcc |
query |
Filter by MCC (Merchant Category Code) |
No |
[ integer ] |
| outlet_municipality_code |
query |
Filter by outlet municipality. Example: 3 |
No |
[ integer ] |
| outlet_name |
query |
Filter by outlet name. Includes full or partial matches. Example: Shop123 |
No |
string |
| outlet_region_code |
query |
Filter by outlet region code. Example: 10 |
No |
[ integer ] |
| outlet_zipcode |
query |
Filter by outlet zip code Example: 2100 |
No |
[ integer ] |
| quarter_range_end |
query |
End quarter in a range of quarters. Example: 3 |
No |
integer |
| quarter_range_start |
query |
Initial quarter in a range of quarters Example: 1 |
No |
integer |
| terminal_id |
query |
Filter by terminal ID. Example: 65546456 |
No |
[ string ] |
| transaction_date |
query |
Filter transactions by date(s). Example: YYYY-MM-DD |
No |
[ date ] |
| transaction_day |
query |
Filter transactions by day(s). Example: 15 |
No |
[ integer ] |
| transaction_hour |
query |
Filter transactions by hour(s). Example: 12 |
No |
[ integer ] |
| transaction_month |
query |
Filter transactions by months(s). Example: 5 |
No |
[ integer ] |
| transaction_quarter |
query |
Filter transactions by quarter(s). Example: 1 |
No |
[ integer ] |
| transaction_week |
query |
Filter transactions by week(s). Example: 20 |
No |
[ integer ] |
| transaction_year |
query |
Filter transactions by year(s). |
No |
[ integer ] |
| vat_code |
query |
Filter by VAT number. Example: 87654321 |
No |
[ integer ] |
| week_number_range_end |
query |
End week in a range of weeks. Example: 52 |
No |
integer |
| week_number_range_start |
query |
Initial week in a range of weeks Example: 5 |
No |
integer |
| year_range_end |
query |
End year in a range of years. Minimum value: Four years earlier than current year Maximum value: Current Year |
No |
integer |
| year_range_start |
query |
Initial year in a range of years Minimum value: Four years earlier than current year Maximum value: Current Year |
No |
integer |
| Ocp-Apim-Subscription-Key |
header |
|
Yes |
string |
