Skip to main content

MonthlyReport

merchantIdstringnullable
monthstringrequired
Example: 2026-01
totals objectrequired
averageTicketnumbernullable

Gross per upstream-reported transaction, including refunds; not a completed-sale average. Null at zero count.

currencystringnullable
currencyTotals object[]
  • Array [
  • averageTicketnumbernullable

    Gross per upstream-reported transaction, including refunds; not a completed-sale average. Null at zero count.

    currencystringrequired
    netAmountnumberrequired

    Refund-adjusted net: upstream gross minus refunds, in currency minor units.

    totalRefundsnumberrequired
    totalSalesnumberrequired
    transactionCountinteger<int64>required

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

  • ]
  • netAmountnumbernullable

    Refund-adjusted net: upstream gross minus refunds, in currency minor units. Null for mixed currencies.

    totalRefundsnumbernullable
    totalSalesnumbernullable
    transactionCountinteger<int64>required

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

    MonthlyReport
    {
    "merchantId": "string",
    "month": "2026-01",
    "totals": {
    "averageTicket": 0,
    "currency": "string",
    "currencyTotals": [
    {
    "averageTicket": 0,
    "currency": "string",
    "netAmount": 0,
    "totalRefunds": 0,
    "totalSales": 0,
    "transactionCount": 0
    }
    ],
    "netAmount": 0,
    "totalRefunds": 0,
    "totalSales": 0,
    "transactionCount": 0
    }
    }