Skip to main content

Reports Function

In addition to being able to view individual Ecommerce transaction detail, it is also possible to return Ecommerce transaction summary information grouped by four different categories. These categories are detailed below.

danger

This endpoint only summarises transactions processed via the card payment method, and for Ecommerce transactions only.

Issuer

View summary information by the card issuer.
MCC

View summary information by the Merchant Category Code.
Merchant

View summary information by the Merchant.
Card Scheme

View summary information by the Card Scheme.

GET Summary by Issuer​

Request​

URL

https://test-api.dnapayments.com/v1/partners/reports/issuer-summary?from={start-date}&to={enddate}&merchantId={merchantId}¤cy={currency}&processor={processor}

This Summary request is completed via a GET request to the test URL shown above, and should contain the below header data. The access_token will be the one received in the Authentication Response. The URL contains several filters which can be applied to narrow the results returned.

HTTP Header
Field NameStateData TypeDescription
Content-TypeMandatoryStringapplication/json
AuthorizationMandatoryStringBearer access_token
GET Summary by Issuer Request
Field NameStateData TypeDescription
fromMandatoryStringStart date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
toMandatoryStringEnd date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
merchantIdOptionalStringUnique id for the merchant, allocated by DNA Payments and returned in GET Merchants.

This field allows for a maximum of 10 ids to be submitted, each separated by a comma.

Specifying the id will only return transactions for this merchant
currencyOptionalStringCurrency for which results are required. This field allows for multiple currencies to be requested, separated by a comma.

ISO 4271 Format [e.g."GBP"]
processorOptionalStringAllows filtering of transactions by the platform responsible for processing the transaction.
dnaTransactions processed via the DNA Payments Acquirer
optomanyTransactions processed via other supported UK Acquirers via our Ecommerce Solutions

Response​

If the request is successful, the method will return the a “200 OK” response code. The response is an array of objects in the following categories.

  • Successful
  • Failed
  • Other See Status Codes to confirm which transactions statuses belong in each category.
GET Summary by Issuer Response
Field NameData TypeDescription
amountDecimalTotal count of records for the requested time period.
countIntegerTotal number of transactions included.
currencyStringCurrencies of the included transactions.

ISO 4271 Format [e.g."GBP"]
issuerStringName of the card issuer. If the issuer could not be determined the field will be passed blank – e.g. “”

Example Response​

{
  "failed": 
  [
    
    {
      "amount": 652,
      "count": 20,
      "currency": "GBP",
      "issuer": "EXTRAS TEST - VISA"
    }
  ],
  "other": 
  [
    
    {
      "amount": 1920,
      "count": 44,
      "currency": "GBP",
      "issuer": "EXTRAS TEST - VISA"
    }
  ],
  "successful": 
  [
    
    {
      "amount": 131283.38,
      "count": 299,
      "currency": "GBP",
      "issuer": "EXTRAS TEST - VISA"
    }
  ]
}

GET Summary by MCC​

Request​

URL

https://test-api.dnapayments.com/v1/partners/reports/mcc-summary?from={start-date}&to={enddate}¤cy={currency}&processor={processor}

This Summary request is completed via a GET request to the test URL shown above, and should contain the below header data. The access_token will be the one received in the Authentication Response. The URL contains several filters which can be applied to narrow the results returned.

HTTP Header
Field NameStateData TypeDescription
Content-TypeMandatoryStringapplication/json
AuthorizationMandatoryStringBearer access_token
GET Summary by MCC Request
Field NameStateData TypeDescription
fromMandatoryStringStart date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
toMandatoryStringEnd date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
currencyOptionalStringCurrency for which results are required. This field allows for multiple currencies to be requested, separated by a comma.

ISO 4271 Format [e.g."GBP"]
processorOptionalStringAllows filtering of transactions by the platform responsible for processing the transaction.
dnaTransactions processed via the DNA Payments Acquirer
optomanyTransactions processed via other supported UK Acquirers via our Ecommerce Solutions

Response​

If the request is successful, the method will return the a “200 OK” response code. The response is an array of objects in the following categories.

  • Successful
  • Failed
  • Other See Status Codes to confirm which transactions statuses belong in each category.
GET Summary by MCC Response
Field NameData TypeDescription
amountDecimalTotal count of records for the requested time period.
countIntegerTotal number of transactions included.
currencyStringCurrencies of the included transactions.

ISO 4271 Format [e.g."GBP"]
mccStringName of the card issuer. If the issuer could not be determined the field will be passed blank – e.g. “”
mccDescriptionStringName of the card issuer. If the issuer could not be determined the field will be passed blank – e.g. “”

Example Response​

{
  "failed": 
  [
    
    {
      "amount": 652,
      "count": 20,
      "currency": "GBP",
      "mcc": "5999",
      "mccDescription": "Miscellaneous and Specialty Retail Stores"
    }
  ],
  "other": 
  [
    
    {
      "amount": 1920,
      "count": 44,
      "currency": "GBP",
      "mcc": "5999",
      "mccDescription": "Miscellaneous and Specialty Retail Stores"
    }
  ],
  "successful": 
  [
    
    {
      "amount": 131283.38,
      "count": 299,
      "currency": "GBP",
      "mcc": "5999",
      "mccDescription": "Miscellaneous and Specialty Retail Stores"
    }
  ]
}

GET Summary by Merchant​

Request​

URL

https://test-api.dnapayments.com/v1/partners/reports/merchant-summary?from={startdate}&to={end-date}&top={top}&merchantId={merchantId}¤cy={currency}&processor={processor}

This Summary request is completed via a GET request to the test URL shown above, and should contain the below header data. The access_token will be the one received in the Authentication Response. The URL contains several filters which can be applied to narrow the results returned.

HTTP Header
Field NameStateData TypeDescription
Content-TypeMandatoryStringapplication/json
AuthorizationMandatoryStringBearer access_token
GET Summary by Merchant Request
Field NameStateData TypeDescription
fromMandatoryStringStart date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
toMandatoryStringEnd date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
currencyOptionalStringCurrency for which results are required. This field allows for multiple currencies to be requested, separated by a comma.

ISO 4271 Format [e.g."GBP"]
topOptionalStringMerchants are ranked by transaction volume; The value here defines the number to include from the top down.

Default = 20, Maximum =100
merchantIdOptionalIntegerUnique id for the merchant, allocated by DNA Payments and returned in GET Merchants.

This field allows for a maximum of 10 ids to be submitted, each separated by a comma.

Specifying the id will only return transactions for this merchant
processorOptionalStringAllows filtering of transactions by the platform responsible for processing the transaction.
dnaTransactions processed via the DNA Payments Acquirer
optomanyTransactions processed via other supported UK Acquirers via our Ecommerce Solutions

Response​

If the request is successful, the method will return the a “200 OK” response code. The response is an array of objects in the following categories.

  • Successful
  • Failed
  • Other See Status Codes to confirm which transactions statuses belong in each category.
GET Summary by Merchant Response
Field NameData TypeDescription
amountDecimalTotal count of records for the requested time period.
countIntegerTotal number of transactions included.
currencyStringCurrencies of the included transactions.

ISO 4271 Format [e.g."GBP"]
merchantIdStringUnique id for the merchant, allocated by DNA Payments
merchantNameIntegerName of the merchant.

Example Response​

{
  "failed": 
  [
    
    {
      "amount": 652,
      "count": 20,
      "currency": "GBP",
      "merchantId": "bdb565d9-4945-4410-bbba-4a8df53cf58f",
      "merchantName": "Demo Merchant"
    },
    
    {
      "amount": 56.45,
      "count": 2,
      "currency": "RUB",
      "merchantId": "bdb565d9-4945-4410-bbba-4a8df53cf58f",
      "merchantName": "Demo Merchant"
    }
  ],
  "other": 
  [
    
    {
      "amount": 1920,
      "count": 44,
      "currency": "GBP",
      "merchantId": "bdb565d9-4945-4410-bbba-4a8df53cf58f",
      "merchantName": "Demo Merchant"
    }
  ],
  "successful": 
  [
    
    {
      "amount": 131283.38,
      "count": 299,
      "currency": "GBP",
      "merchantId": "bdb565d9-4945-4410-bbba-4a8df53cf58f",
      "merchantName": "Demo Merchant"
    },
    
    {
      "amount": 4393.2,
      "count": 13,
      "currency": "USD",
      "merchantId": "bdb565d9-4945-4410-bbba-4a8df53cf58f",
      "merchantName": "Demo Merchant"
    }
  ]
}

GET Summary by Scheme​

Request​

URL

https://test-api.dnapayments.com/v1/partners/reports/card-scheme-summary?from={startdate}&to={end-date}&merchantId={merchantId}¤cy={currency}&processor={processor}

This Summary request is completed via a GET request to the test URL shown above, and should contain the below header data. The access_token will be the one received in the Authentication Response. The URL contains several filters which can be applied to narrow the results returned.

HTTP Header
Field NameStateData TypeDescription
Content-TypeMandatoryStringapplication/json
AuthorizationMandatoryStringBearer access_token
GET Summary by Scheme Request
Field NameStateData TypeDescription
fromMandatoryStringStart date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
toMandatoryStringEnd date for transactions. Transactions are available for 365 days and a maximum of 30 days can be specified.

ISO 8601 Format [e.g. 2021-01-25T15:29:56Z]
merchantIdOptionalStringUnique id for the merchant, allocated by DNA Payments and returned in GET Merchants.

This field allows for a maximum of 10 ids to be submitted, each separated by a comma.

Specifying the id will only return transactions for this merchant
currencyOptionalStringCurrency for which results are required. This field allows for multiple currencies to be requested, separated by a comma.

ISO 4271 Format [e.g."GBP"]
processorOptionalStringAllows filtering of transactions by the platform responsible for processing the transaction.
dnaTransactions processed via the DNA Payments Acquirer
optomanyTransactions processed via other supported UK Acquirers via our Ecommerce Solutions

Response​

If the request is successful, the method will return the a “200 OK” response code. The response is an array of objects in the following categories.

  • Successful
  • Failed
  • Other See Status Codes to confirm which transactions statuses belong in each category.
GET Summary by Issuer Response
Field NameData TypeDescription
amountDecimalTotal count of records for the requested time period.
countIntegerTotal number of transactions included.
currencyStringCurrencies of the included transactions.

ISO 4271 Format [e.g."GBP"]
cardSchemeStringName of the card scheme.

Example Response​

{
  "failed": 
  [
    
    {
      "amount": 652,
      "cardScheme": "visa",
      "count": 20,
      "currency": "GBP"
    },
    
    {
      "amount": 56.45,
      "cardScheme": "visa",
      "count": 2,
      "currency": "RUB"
    }
  ],
  "other": 
  [
    
    {
      "amount": 1920,
      "cardScheme": "visa",
      "count": 44,
      "currency": "GBP"
    }
  ],
  "successful": 
  [
    
    {
      "amount": 131283.38,
      "cardScheme": "visa",
      "count": 299,
      "currency": "GBP"
    },
    
    {
      "amount": 4393.2,
      "cardScheme": "visa",
      "count": 13,
      "currency": "USD"
    }
  ]
}