Reports API

Get payment volume by Date Range

GET /api/v1/reports/payment-volume

Required URL Query Parameters

• pspMerchantAccountName (string): The name of the parent Adyen merchant account.
• organizationId (string): Specifies the organizationId ID to filter payment volumes by organization.
• fromDate (date): The start date for the payment event period in ISO 8601 format.
• toDate (date): The end date for the payment event period in ISO 8601 format.

Optional URL Query Parameters

• merchantAccountId (string): Specifies the merchant ID to filter payment volumes by merchant.

Response

{
  "status": "ok",
  "data": {
    "currency": "USD",
    "rows": [
      {
        "date": "2024-06-01",
        "volume": 0
      },
      {
        "date": "2024-06-02",
        "volume": 16037
      },
      {
        "date": "2024-06-03",
        "volume": 48488
      },
      {
        "date": "2024-06-04",
        "volume": 45244
      },
      {
        "date": "2024-06-05",
        "volume": 0
      },
      {
        "date": "2024-06-06",
        "volume": 68146
      },
      {
        "date": "2024-06-07",
        "volume": 67008
      },
      {
        "date": "2024-06-08",
        "volume": 98881
      },
      {
        "date": "2024-06-09",
        "volume": 0
      },
      {
        "date": "2024-06-10",
        "volume": 0
      },
      {
        "date": "2024-06-11",
        "volume": 0
      },
      {
        "date": "2024-06-12",
        "volume": 114818
      },
      {
        "date": "2024-06-13",
        "volume": 76513
      },
      {
        "date": "2024-06-14",
        "volume": 24106
      },
      {
        "date": "2024-06-15",
        "volume": 16623
      },
      {
        "date": "2024-06-16",
        "volume": 110447
      },
      {
        "date": "2024-06-17",
        "volume": 0
      },
      {
        "date": "2024-06-18",
        "volume": 0
      },
      {
        "date": "2024-06-19",
        "volume": 32225
      },
      {
        "date": "2024-06-20",
        "volume": 130977
      },
      {
        "date": "2024-06-21",
        "volume": 0
      },
      {
        "date": "2024-06-22",
        "volume": 10534
      },
      {
        "date": "2024-06-23",
        "volume": 80717
      },
      {
        "date": "2024-06-24",
        "volume": 229553
      },
      {
        "date": "2024-06-25",
        "volume": 35865
      },
      {
        "date": "2024-06-26",
        "volume": 40337
      },
      {
        "date": "2024-06-27",
        "volume": 0
      },
      {
        "date": "2024-06-28",
        "volume": 185129
      },
      {
        "date": "2024-06-29",
        "volume": 55542
      },
      {
        "date": "2024-06-30",
        "volume": 90348
      },
      {
        "date": "2024-07-01",
        "volume": 0
      }
    ]
  }
}

Get payment summary by Date Range

GET /api/v1/reports/payment-summary

Required URL Query Parameters

• pspMerchantAccountName (string): The name of the parent Adyen merchant account.
• organizationId (string): Specifies the organizationId ID to filter payment summary by organization.
• fromDate (date): The start date for the payment event period in ISO 8601 format.
• toDate (date): The end date for the payment event period in ISO 8601 format.

Optional URL Query Parameters:

• merchantAccountId (string): Specifies the merchant ID to filter payment summary by merchant.

Response

{
  "status": "ok",
  "data": {
    "currency": "USD",
    "totalVolume": 1329716,
    "averageVolume": 40294,
    "totalRefundedVolume": 193226,
    "totalPaymentsCount": 33,
    "totalChargebacksVolume": 84707,
    "achChargebacksCount": 0,
    "cardChargebackCount": 4
  }
}

Get transactions profitability report

GET /api/v1/reports/transaction-profitability

Required URL Query Parameters

• type (enum - organizations, merchants): Get organizations transaction profitability or merchants transaction profitability.
• pspMerchantAccountName (string): The name of the parent Adyen merchant account.
• organizationId (string): Specifies the organizationId ID to filter transactions profitability report by organization.
• fromDate (date): The start date for the report period in ISO 8601 format.
• toDate (date): The end date for the report period in ISO 8601 format.

Optional URL Query Parameters:

• merchantAccountId (string): Specifies the merchant ID to filter payment summary by merchant.

Organizations transaction profitability response

{
  "status": "ok",
  "data": {
    "rows": [
      {
        "totalVolume": 6182163,
        "totalPaymentsCount": 121,
        "averageVolume": 51092,
        "pspMerchantAccountName": "DentalSolutions_US",
        "organizationId": "bf368afb-ed57-4345-a04a-7c7213431a99",
        "organizationName": "Big Smile",
        "referenceId": null,
        "processingCost": 184757,
        "gatewayFee": 1230,
        "totalRevenue": 185458,
        "net": 5811948
      }
    ],
    "pagination": {
      "pageCount": 1,
      "total": 1
    }
  }
}

Merchants transaction profitability response

{
  "status": "ok",
  "data": {
    "rows": [
      {
        "businessName": "Pediatric Dental",
        "tenantMerchantReferenceId": "PmKJCtk8ecvpYcUjbEi6Y",
        "totalVolume": 1449206,
        "totalPaymentsCount": 28,
        "averageVolume": 51757,
        "pspMerchantAccountName": "DentalSolutions_US",
        "merchantAccountId": "MERYVF6TS47YY",
        "organizationName": "Big Smile",
        "organizationReferenceId": null,
        "processingCost": 43925,
        "totalRevenue": 43476,
        "net": 1361805,
        "gatewayFee": 280,
        "currency": "USD"
      }
    ],
    "pagination": {
      "pageCount": 1,
      "total": 1
    }
  }
}