Skip to main content

DashboardMetrics

currencystringnullable
currencyTotals object[]
  • Array [
  • currencystringrequired
    netAmountinteger<int64>required

    Refund-adjusted net: upstream operational gross minus refunds, in currency minor units; not settlement proceeds.

    settlementPendinginteger<int64>required
    totalAmountinteger<int64>required
    totalRefundsinteger<int64>required
    totalSalesinteger<int64>required
    transactionCountinteger<int64>required

    Upstream operational transaction count, including refunds; not completed-sale count.

  • ]
  • hourlyVolume object[]required
  • Array [
  • hourinteger<int32>required
    transactionCountinteger<int64>required
  • ]
  • merchantCountinteger<int64>required
    recentTransactions object[]required
  • Array [
  • amountinteger<int64>required
    createdAtstringrequired
    currencystringnullable
    idstringrequired
    merchantIdstringrequired
    statusstringrequired
  • ]
  • salesTrend object[]required
  • Array [
  • datestring<date>required
    salesByCurrency object[]required
  • Array [
  • currencystringrequired
    salesAmountinteger<int64>required
  • ]
  • transactionCountinteger<int64>required
  • ]
  • settlementPendinginteger<int64>nullable
    timeZonestringrequired
    totalVolumeTodayinteger<int64>nullable

    Upstream operational transaction volume in currency minor units, including refunds; not completed-sale gross. Null for mixed currencies; use currencyTotals.

    transactionCountTodayinteger<int64>required

    Upstream operational transaction count, including refunds; not completed-sale count.

    DashboardMetrics
    {
    "currency": "string",
    "currencyTotals": [
    {
    "currency": "string",
    "netAmount": 0,
    "settlementPending": 0,
    "totalAmount": 0,
    "totalRefunds": 0,
    "totalSales": 0,
    "transactionCount": 0
    }
    ],
    "hourlyVolume": [
    {
    "hour": 0,
    "transactionCount": 0
    }
    ],
    "merchantCount": 0,
    "recentTransactions": [
    {
    "amount": 0,
    "createdAt": "string",
    "currency": "string",
    "id": "string",
    "merchantId": "string",
    "status": "string"
    }
    ],
    "salesTrend": [
    {
    "date": "2024-07-29",
    "salesByCurrency": [
    {
    "currency": "string",
    "salesAmount": 0
    }
    ],
    "transactionCount": 0
    }
    ],
    "settlementPending": 0,
    "timeZone": "string",
    "totalVolumeToday": 0,
    "transactionCountToday": 0
    }