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.

Authentication

requestTokenstring
API Key authentication via header

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

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
inACHReturnsinteger
inACHReturnsVolumedouble
inACHTransactionsinteger
inACHVolumedouble
inCardChargeBacksinteger
inCardChargeBackVolumedouble
inCardTransactionsinteger
inCardVolumedouble
inCashTransactionsinteger
inCashVolumedouble
inCheckTransactionsinteger
inCheckVolumedouble
inCustomersinteger
inNewCustomersinteger
inSubscriptionsPaidinteger
inSubscriptionsPaidVolumedouble
inTransactionsinteger
inTransactionsVolumedouble
outACHTransactionsinteger
outACHVolumedouble
outCardTransactionsinteger
outCardVolumedouble
outCheckTransactionsinteger
outCheckVolumedouble
outCustomersinteger
outNewCustomersinteger
outSubscriptionsPaidinteger
outSubscriptionsPaidVolumedouble
outTransactionsinteger
outTransactionsVolumedouble
outVCardTransactionsinteger
outVCardVolumedouble
statXstring

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error