Get stats for an org or paypoint

GET

/Statistic/basic/:mode/:freq/:level/:entryId

GET

/api/Statistic/basic/:mode/:freq/:level/:entryId

$ curl -G https://api-sandbox.payabli.com/api/Statistic/basic/custom/m/2/1000000 \
>      -H "requestToken: <apiKey>" \
>      -d endDate=2025-11-30 \
>      -d startDate=2025-11-01

1 [
2   {
3     "statX": "2025-11",
4     "outCustomers": 18196,
5     "outNewCustomers": 1089,
6     "outTransactions": 3319,
7     "outSubscriptionsPaid": 0,
8     "outCardTransactions": 0,
9     "outVCardTransactions": 0,
10     "outACHTransactions": 0,
11     "outCheckTransactions": 0,
12     "outPendingMethodTransactions": 22,
13     "outRTPTransactions": 8,
14     "outRTPVolume": 12500,
15     "outWireTransactions": 5,
16     "outWireVolume": 47800,
17     "outTransactionsVolume": 13111741.78,
18     "outSubscriptionsPaidVolume": 0,
19     "outCardVolume": 0,
20     "outVCardVolume": 0,
21     "outACHVolume": 0,
22     "outCheckVolume": 0,
23     "outPendingMethodVolume": 82,
24     "inTransactions": 168204,
25     "inSubscriptionsPaid": 311,
26     "inCustomers": 2561522,
27     "inNewCustomers": 44846,
28     "inCardTransactions": 115059,
29     "inACHTransactions": 53153,
30     "inCheckTransactions": 0,
31     "inCashTransactions": 15,
32     "inWalletTransactions": 0,
33     "inCardChargeBacks": 17,
34     "inACHReturns": 0,
35     "inTransactionsVolume": 104795896.94,
36     "inSubscriptionsPaidVolume": 81569.32,
37     "inCardVolume": 41085285.13,
38     "inACHVolume": 63706101.81,
39     "inCheckVolume": 0,
40     "inCashVolume": 4510,
41     "inWalletVolume": 0,
42     "inCardChargeBackVolume": 15455.75,
43     "inACHReturnsVolume": 0
44   }
45 ]

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

Authentication

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

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 nullable 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

statXstring

The time window based on the mode and frequency used for the query.

outCustomersinteger

Number of active vendors.

outNewCustomersinteger

Number of new vendors.

outTransactionsinteger

Outbound (payout) transactions count.

outSubscriptionsPaidinteger

Recurring outbound (payout) transactions count.

outCardTransactionsinteger

Outbound (payout) pCard transactions count.

outVCardTransactionsinteger

Outbound (payout) vCard transactions count.

outACHTransactionsinteger

Outbound (payout) ACH transactions count.

outCheckTransactionsinteger

Outbound (payout) check transactions count.

outPendingMethodTransactionsinteger

Outbound (payout) Managed Payables transactions count.

outRTPTransactionsinteger

Outbound (payout) RTP transactions count.

outRTPVolumedouble

Outbound (payout) RTP transactions volume.

outWireTransactionsinteger

Outbound (payout) wire transactions count.

outWireVolumedouble

Outbound (payout) wire transactions volume.

outTransactionsVolumedouble

Outbound (payout) volume.

outSubscriptionsPaidVolumedouble

Recurring outbound (payout) volume.

outCardVolumedouble

Outbound (payout) pCard transactions volume.

outVCardVolumedouble

Outbound (payout) vCard transactions volume.

outACHVolumedouble

Outbound (payout) ACH transactions volume.

outCheckVolumedouble

Outbound (payout) check transactions volume.

outPendingMethodVolumedouble

Outbound (payout) Managed Payables volume.

inTransactionsinteger

Inbound transactions count.

inSubscriptionsPaidinteger

Inbound recurring transactions count.

inCustomersinteger

Number of active customers.

inNewCustomersinteger

Number of new customers.

inCardTransactionsinteger

Inbound card transactions count.

inACHTransactionsinteger

Inbound ACH transactions count.

inCheckTransactionsinteger

Inbound check transactions count.

inCashTransactionsinteger

Inbound cash transactions count.

inWalletTransactionsinteger

Inbound wallet transactions count.

inCardChargeBacksinteger

Inbound card chargebacks and returns count.

inACHReturnsinteger

Inbound ACH returns count.

inTransactionsVolumedouble

Inbound volume.

inSubscriptionsPaidVolumedouble

Inbound recurring payments volume.

inCardVolumedouble

Inbound card volume.

inACHVolumedouble

Inbound ACH volume.

inCheckVolumedouble

Inbound check volume.

inCashVolumedouble

Inbound cash volume recognized.

inWalletVolumedouble

Inbound wallet transactions volume.

inCardChargeBackVolumedouble

Inbound Card chargebacks and returns volume.

inACHReturnsVolumedouble

Inbound ACH returns volume.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error