reports

Get transaction report totals and history. (read access required)

Changed on

Returns totals, per-wallet and role totals, and time buckets from one database snapshot. The service calculates applicable V1 protocol fees from the payment source rate. Applicable V2 protocol fees are exact zero.

post/reports/summary

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/reports/summary
  • Auth: API key in header token

Request body

paymentSourceIdstring required
managedWalletIdsstring[]
externalAddressesstring[]
rolesstring[]
fromstring date-time nullable required
tostring date-time nullable required
dateBasis'CreatedAt' | 'FundsLockedAt' | 'RevenueRecognizedAt'
revenueMode'Billable' | 'CashReceived' | 'RequestedGross'
timeZonestring
bucket'Auto' | 'Day' | 'Week' | 'Month'

Example request

{
  "paymentSourceId": "payment_source_id",
  "managedWalletIds": [
    "managed_wallet_id"
  ],
  "externalAddresses": [
    "addr_test1_external"
  ],
  "roles": [
    "Buyer",
    "Seller"
  ],
  "states": [
    "FundsLocked",
    "Withdrawn"
  ],
  "from": "2026-01-01T00:00:00.000Z",
  "to": "2026-02-01T00:00:00.000Z",
  "dateBasis": "RevenueRecognizedAt",
  "revenueMode": "Billable",
  "timeZone": "Etc/UTC",
  "bucket": "Auto"
}

Response

Transaction report totals and history

status'success' required

Example response

{
  "status": "success",
  "data": {
    "totals": {
      "transactionCount": 0,
      "transactionCountCompleteness": "complete",
      "sellerGrossRevenue": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "protocolFees": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "sellerCardanoFees": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "actorCardanoFees": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "sellerNetRevenue": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "buyerGrossSpend": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "returnedFunds": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "buyerCardanoFees": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "buyerNetSpend": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "adminCardanoFees": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      },
      "totalCardanoFees": {
        "amounts": [
          {
            "unit": "lovelace",
            "rawAmount": "0",
            "decimalAmount": "0.000000",
            "decimals": 6,
            "symbol": "ADA"
          }
        ],
        "completeness": "complete"
      }
    },
    "wallets": [],
    "history": [],
    "bucket": "Day",
    "metadata": {
      "generatedAt": "2026-02-01T00:00:01.000Z",
      "asOf": "2026-02-01T00:00:00.000Z",
      "paymentSource": {
        "id": "payment_source_id",
        "network": "Preprod",
        "paymentSourceType": "Web3CardanoV2",
        "feeRatePermille": 0,
        "smartContractAddress": "addr_test1_contract",
        "deletedAt": null
      },
      "filters": {
        "paymentSourceId": "payment_source_id",
        "managedWalletIds": [
          "managed_wallet_id"
        ],
        "externalAddresses": [
          "addr_test1_external"
        ],
        "roles": [
          "Buyer",
          "Seller"
        ],
        "states": [
          "FundsLocked",
          "Withdrawn"
        ],
        "from": "2026-01-01T00:00:00.000Z",
        "to": "2026-02-01T00:00:00.000Z",
        "dateBasis": "RevenueRecognizedAt",
        "revenueMode": "Billable",
        "timeZone": "Etc/UTC"
      },
      "warnings": []
    }
  }
}

Changes