Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Statistics

Statistics:Management

Get statistical information regarding your transactions. You can set several filters and you can group the the results in max 2 levels. Note always one group by is required. If you supply a merchantCode you need to have access to that merchant.

get/v2/statistics/management

Query parameters

startDatestring date required
Example:2024-06-04

Start date; Please provide a start date in YYYY-MM-DD format

endDatestring date required
Example:2024-06-04

End date; Please provide an end date in YYYY-MM-DD format

groupBy[0]'paymentMethod' | 'paymentMethodBrand' | 'paymentMethodGroup' | 'day' | 'month' | 'year' | 'tool' | 'info' | 'merchantCode' | 'ipAddress' | 'extra1' | 'week' | 'turnoverGroup' | 'extra2' | 'extra3' | 'object' | 'paymentSession' | 'hour' | 'startTime' | 'amount' | 'createdAt' | 'orderId' | 'countryCode' | 'countryName' | 'stopTime' | 'service' | 'reference' | 'terminal' | 'paymentProfile' | 'description' | 'reconciliationStatus' | 'reconciliationReceivedAt' | 'paymentType' | 'direction' | 'collecting' | 'customerKey' | 'customerId' | 'customerName' | 'customerEmail' | 'paymentVerificationMethod' | 'merchant' | 'completedTime' | 'createdTimestamp' | 'startedTimestamp' | 'completedTimestamp' | 'limit' | 'page' required

The first grouping of the results

groupBy[1]'paymentMethod' | 'paymentMethodBrand' | 'paymentMethodGroup' | 'day' | 'month' | 'year' | 'tool' | 'info' | 'merchantCode' | 'ipAddress' | 'extra1' | 'week' | 'turnoverGroup' | 'extra2' | 'extra3' | 'object' | 'paymentSession' | 'hour' | 'startTime' | 'amount' | 'createdAt' | 'orderId' | 'countryCode' | 'countryName' | 'stopTime' | 'service' | 'reference' | 'terminal' | 'paymentProfile' | 'description' | 'reconciliationStatus' | 'reconciliationReceivedAt' | 'paymentType' | 'direction' | 'collecting' | 'customerKey' | 'customerId' | 'customerName' | 'customerEmail' | 'paymentVerificationMethod' | 'merchant' | 'completedTime' | 'createdTimestamp' | 'startedTimestamp' | 'completedTimestamp' | 'limit' | 'page'

The second layer of grouping of the results

gteinteger

Get results that are greater than or equals to the provided value.

gtinteger

Get results that are greater than the provided value.

eqinteger

Get results that equal the provided value.

ltinteger

Get results that are less than the provided value.

lteinteger

Get results that are less than or equals to the provided value.

The amounts in cents to filter on. Є1.50 becomes 150

{
  "gte": 15,
  "gt": 15,
  "eq": 15,
  "lt": 15,
  "lte": 15
}
eqinteger

Get results that equal the provided value.

neqinteger

Get results that does not equal the provided value.

ininteger

Get results that exist in the provided values.

nininteger

Get results that do not exists in the provided values.

lteinteger

Get results that are less than or equals to the provided value.

The Country ID to search for

{
  "eq": 12,
  "neq": 12,
  "in": 12,
  "nin": 12,
  "lte": 12
}
gtestring date-time

Get results that are greater than or equals to the provided value.

gtstring date-time

Get results that are greater than the provided value.

eqstring date-time

Get results that equal the provided value.

ltstring date-time

Get results that are less than the provided value.

ltestring date-time

Get results that are less than or equals to the provided value.

UNIX Timestamp of the created at datetime

{
  "gte": "1730809313",
  "gt": "1730809313",
  "eq": "1730809313",
  "lt": "1730809313",
  "lte": "1730809313"
}
eqinteger

Get results that equal the provided value.

neqinteger

Get results that does not equal the provided value.

ininteger

Get results that exist in the provided values.

nininteger

Get results that do not exists in the provided values.

The day of the resultset

{
  "eq": 23,
  "neq": 23,
  "in": 23,
  "nin": 23
}
eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

likestring

Get results that contain the provided value.

isNullstring

Get results that is null or not null

The extra field to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

likestring

Get results that contain the provided value.

isNullstring

Get results that is null or not null

The extra field to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

likestring

Get results that contain the provided value.

isNullstring

Get results that contain the provided value.

The extra field to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

The hour of the resultset

{
  "eq": "22:00",
  "neq": "22:00",
  "in": "22:00",
  "nin": "22:00"
}
eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

likestring

Get results that contain the provided value.

isNullstring

Get results that is null or not null

The info field to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

likestring

Get results that contain the provided value.

The IP address that is used

{
  "eq": "127.0.0.1",
  "neq": "127.0.0.1",
  "like": "127.0.0.1"
}
merchantstring

The merchant code to filter on

merchantCodestring

The merchant code to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

The month of the resultset

{
  "eq": "2024-12",
  "neq": "2024-12",
  "in": "2024-12",
  "nin": "2024-12"
}
eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

likestring

Get results that contain the provided value.

isNullstring

Get results that is null or not null

The object field to filter on

eqinteger

Get results that equal the provided value.

neqinteger

Get results that does not equal the provided value.

ininteger

Get results that exist in the provided values.

nininteger

Get results that do not exists in the provided values.

The order ID to filter on

{
  "eq": 1234,
  "neq": 1234,
  "in": 1234,
  "nin": 1234
}
eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

The payment method brand to filter on

{
  "eq": "iDEAL",
  "neq": "iDEAL",
  "in": "iDEAL",
  "nin": "iDEAL"
}
eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

The payment method that is used

paymentSessionstring

The payment session ID to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

isNullstring

Get results that is null or not null

The order reference to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

The service (website location) to filter on

{
  "eq": "SL-1234-4321",
  "neq": "SL-1234-4321",
  "in": "SL-1234-4321",
  "nin": "SL-1234-4321"
}
gtestring

Get results that are greater than or equals to the provided value.

gtstring

Get results that are greater than the provided value.

eqstring

Get results that equal the provided value.

ltstring

Get results that are less than the provided value.

ltestring

Get results that are less than or equals to the provided value.

The start time to filter on

{
  "gte": "23:00",
  "gt": "23:00",
  "eq": "23:00",
  "lt": "23:00",
  "lte": "23:00"
}
gtestring

Get results that are greater than or equals to the provided value.

gtstring

Get results that are greater than the provided value.

eqstring

Get results that equal the provided value.

ltstring

Get results that are less than the provided value.

ltestring

Get results that are less than or equals to the provided value.

The stop time to filter on

{
  "gte": "23:00",
  "gt": "23:00",
  "eq": "23:00",
  "lt": "23:00",
  "lte": "23:00"
}
eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

likestring

Get results that contain the provided value.

isNullstring

Get results that is null or not null

The tool field to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

The turnover group to filter on

eqstring

Get results that equal the provided value.

neqstring

Get results that does not equal the provided value.

instring

Get results that exist in the provided values.

ninstring

Get results that do not exists in the provided values.

isNullstring

Get results that is null or not null

The terminal to filter on

{
  "eq": "TH-1234-4321",
  "neq": "TH-1234-4321",
  "in": "TH-1234-4321",
  "nin": "TH-1234-4321",
  "isNull": "TH-1234-4321"
}
eqinteger

Get results that equal the provided value.

neqinteger

Get results that does not equal the provided value.

ininteger

Get results that exist in the provided values.

nininteger

Get results that do not exists in the provided values.

The week of the resultset

{
  "eq": 52,
  "neq": 52,
  "in": 52,
  "nin": 52
}
eqinteger

Get results that equal the provided value.

neqinteger

Get results that does not equal the provided value.

ininteger

Get results that exist in the provided values.

nininteger

Get results that do not exists in the provided values.

The year of the resultset

{
  "eq": 2024,
  "neq": 2024,
  "in": 2024,
  "nin": 2024
}

Response

OK

Example response

{
  "statistics": [
    {
      "label": "iDeal",
      "data": [
        {
          "volume": 3,
          "costs": 3,
          "transactions": 3,
          "averagePaidAmount": 3,
          "internalVolume": 3,
          "externalVolume": 3,
          "totalVolume": 3
        }
      ]
    }
  ]
}