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

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

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

freqstringRequired

Frequency to group series. Allowed values:

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

For example, w groups the results by week.

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

entryIdlongRequired

Identifier in Payabli for the entity.

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

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

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.

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.

inCardChargeBackVolumedouble

Inbound Card chargebacks and returns volume.

inACHReturnsVolumedouble

Inbound ACH returns volume.

1	from payabli import payabli
2
3	client = payabli(
4	api_key="YOUR_API_KEY",
5	)
6	client.statistic.basic_stats(
7	entry_id=1000000,
8	freq="m",
9	level=1,
10	mode="ytd",
11	end_date="2023-05-23",
12	start_date="2023-03-23",
13	)

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	"outTransactionsVolume": 13111741.78,
14	"outSubscriptionsPaidVolume": 0,
15	"outCardVolume": 0,
16	"outVCardVolume": 0,
17	"outACHVolume": 0,
18	"outCheckVolume": 0,
19	"outPendingMethodVolume": 82,
20	"inTransactions": 168204,
21	"inSubscriptionsPaid": 311,
22	"inCustomers": 2561522,
23	"inNewCustomers": 44846,
24	"inCardTransactions": 115059,
25	"inACHTransactions": 53153,
26	"inCheckTransactions": 0,
27	"inCashTransactions": 15,
28	"inWalletTransactions": 0,
29	"inCardChargeBacks": 17,
30	"inACHReturns": 0,
31	"inTransactionsVolume": 104795896.94,
32	"inSubscriptionsPaidVolume": 81569.32,
33	"inCardVolume": 41085285.13,
34	"inACHVolume": 63706101.81,
35	"inCheckVolume": 0,
36	"inCashVolume": 4510,
37	"inWalletVolume": 0,
38	"inCardChargeBackVolume": 15455.75,
39	"inACHReturnsVolume": 0
40	}
41	]

Authentication

Path parameters

Query parameters

Response

Errors