v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get User Sales Report

get/v3/report/usersales

Query parameters

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)

limitinteger

offsetinteger

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

Response

200

recordCountinteger

Example response

{
  "records": [
    {
      "transactionCount": 2,
      "amount": "0.01",
      "username": "Jane Clerk",
      "reference": "803320000109",
      "transactionType": "Sale",
      "tenderType": "Cash",
      "transactionDate": "2018-02-02T20:49:39.937",
      "invoiceNumber": "9011VQWL",
      "recordCount": 2,
      "totalAmount": "0.02",
      "paymentType": "Cash",
      "id": 22044600,
      "source": "QuickPay",
      "status": "Approved"
    }
  ],
  "recordCount": 2,
  "totals": {
    "transactionCount": 2,
    "totalAmount": "0.02"
  }
}