Sign in
reports

Get transaction report rows. (read access required)

Changed on

Returns paginated buyer and seller report rows for one payment source. The cursor preserves the initial asOf boundary and source fee settings, but it does not preserve historical row values. Amounts include raw atomic units and decimal metadata for supported assets.

post/reports/transactions

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/transactions
  • 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
cursorstring
limitinteger

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",
  "limit": 50
}

Response

Transaction report rows

status'success' required

Example response

{
  "status": "success",
  "data": {
    "rows": [],
    "page": {
      "nextCursor": null,
      "hasMore": false
    },
    "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