ReportResponse

successbooleanrequired

data object

Response payload for successful operations.

datestring<date>

monthstring

Possible values: Value must match regular expression ^[0-9]{4}-[0-9]{2}$

merchantIdstringnullable

currencystringnullable

Possible values: Value must match regular expression ^[A-Z]{3}$

totalSalesnumbernullable

totalRefundsnumbernullable

netAmountnumbernullable

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

transactionCountinteger<int64>

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

averageTicketnumbernullable

Gross per upstream-reported transaction, including refunds, in currency minor units; not a completed-sale average. Null at zero count or for mixed currencies; use currencyTotals.

currencyTotals object[]

Array [

currencystringrequired

Possible values: Value must match regular expression ^[A-Z]{3}$

totalSalesnumberrequired

totalRefundsnumberrequired

netAmountnumberrequired

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

transactionCountinteger<int64>required

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

averageTicketnumbernullablerequired

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

]

property name*any

Response payload for successful operations.

errorstring

Machine-readable error code.

messagestring

Human-readable response message.

ReportResponse
{
  "success": true,
  "data": {
    "date": "2024-07-29",
    "month": "string",
    "merchantId": "string",
    "currency": "string",
    "totalSales": 0,
    "totalRefunds": 0,
    "netAmount": 0,
    "transactionCount": 0,
    "averageTicket": 0,
    "currencyTotals": [
      {
        "currency": "string",
        "totalSales": 0,
        "totalRefunds": 0,
        "netAmount": 0,
        "transactionCount": 0,
        "averageTicket": 0
      }
    ]
  },
  "error": "string",
  "message": "string"
}