API referencePay Ops endpointsBusiness entities

Get stats for an org or paypoint

Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.

Path parameters

entryIdlongRequired
Identifier in Payabli for the entity.
freqstringRequired

Frequency to group series. Allowed values:

  • m - monthly
  • w - weekly
  • d - daily
  • h - hourly

For example, w groups the results by week.

levelintegerRequired

The entry level for the request:

  • 0 for Organization
  • 2 for Paypoint
modestringRequired

Mode for the request. Allowed values:

  • custom - Allows you to set a custom date range
  • ytd - Year To Date
  • mtd - Month To Date
  • wtd - Week To Date
  • today - All current day
  • m12 - Last 12 months
  • d30 - Last 30 days
  • h24 - Last 24 hours
  • lasty - Last Year
  • lastm - Last Month
  • lastw - Last Week
  • yesterday - Last Day

Headers

requestTokenstringRequired

Query parameters

endDatestringOptional

Used with custom mode. The end date for the range. Valid formats:

  • YYYY-mm-dd
  • YYYY/mm/dd
  • mm-dd-YYYY
  • mm/dd/YYYY
parametersmap from strings to optional stringsOptional
List of parameters.
startDatestringOptional

Used with custom mode. The start date for the range. Valid formats:

  • YYYY-mm-dd
  • YYYY/mm/dd
  • mm-dd-YYYY
  • mm/dd/YYYY

Response

Success
additionalPropertiesany or null
inACHReturnsinteger or null
inACHReturnsVolumedouble or null
inACHTransactionsinteger or null
inACHVolumedouble or null
inCardChargeBacksinteger or null
inCardChargeBackVolumedouble or null
inCardTransactionsinteger or null
inCardVolumedouble or null
inCashTransactionsinteger or null
inCashVolumedouble or null
inCheckTransactionsinteger or null
inCheckVolumedouble or null
inCustomersinteger or null
inNewCustomersinteger or null
inSubscriptionsPaidinteger or null
inSubscriptionsPaidVolumedouble or null
inTransactionsinteger or null
inTransactionsVolumedouble or null
outACHTransactionsinteger or null
outACHVolumedouble or null
outCardTransactionsinteger or null
outCardVolumedouble or null
outCheckTransactionsinteger or null
outCheckVolumedouble or null
outCustomersinteger or null
outNewCustomersinteger or null
outSubscriptionsPaidinteger or null
outSubscriptionsPaidVolumedouble or null
outTransactionsinteger or null
outTransactionsVolumedouble or null
outVCardTransactionsinteger or null
outVCardVolumedouble or null
statXstring or null

Errors