v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get User Sales Summary Report

get/v3/report/usersalessummary

merchantIdinteger required

Merchant id

dateRangestring

Date type filter. Values: Lifetime, Today, Yesterday, Week, Month, Last7, Last30, Custom

startDatestring date

Start date in MM/DD/YYYY format (Only needed if dateTypeFilter is set to Custom)

endDatestring date

End date in MM/DD/YYYY format (Only needed if dateTypeFilter is set to Custom)

transactionTypestring

Transaction type. Values: Any, Sale, Refund, Authorization

statusstring

Transaction status. Values: Any, Approved, Voided, Declined

minAmountinteger

Minimum transaction amount to return

maxAmountinteger

Maximum transaction amount to return

200

recordCountinteger

{
  "records": [
    {
      "userName": "Jane Clerk",
      "transactionCount": 70,
      "totalAmount": "354.76"
    }
  ],
  "recordCount": 2
}