Statistic

Get Basic statistics for a paypoint or organization

Retrieves the basic statistics for an organization or a paypoint over a date range, grouped by a frequency. The response returns one row per time bucket. Counts and volumes cover approved transactions only and leave out declines. Volumes are net of fees.

get/Statistic/basic/{mode}/{freq}/{level}/{entryId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Statistic/basic/{mode}/{freq}/{level}/{entryId}
  • Auth: HTTP bearer

Path parameters

entryIdinteger required

Identifier in Payabli for the entity.

freqstring required

Frequency to group series. Allowed values:

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

For example, w groups the results by week.

levelinteger required

The entry level for the request:

  • 0 for Organization
  • 2 for Paypoint
modestring required

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

endDatestring

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

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

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 required

The time bucket for this row, formatted according to the query's freq (for example, 2025-11 for a monthly bucket). The response returns one object per bucket across the requested range.

outCustomersinteger required

Cumulative number of vendors, as a running total through the end of this bucket rather than a per-bucket count. On the payout (money out) side, "customers" are vendors.

outNewCustomersinteger required

Number of vendors created during this bucket, scoped to the paypoint (level 2) or organization (level 0).

outTransactionsinteger required

Count of payout (money out) transactions. The payout method counts (outCardTransactions, outVCardTransactions, outACHTransactions, outCheckTransactions, outPendingMethodTransactions, outRTPTransactions, outWireTransactions) are mutually exclusive and together account for this total.

outSubscriptionsPaidinteger required

Count of payout transactions generated by a recurring schedule.

outCardTransactionsinteger required

Count of payout transactions sent by pCard.

outVCardTransactionsinteger required

Count of payout transactions sent by virtual card (vCard).

outACHTransactionsinteger required

Count of payout transactions sent by ACH.

outCheckTransactionsinteger required

Count of payout transactions sent by check.

outPendingMethodTransactionsinteger required

Count of payout transactions held as Managed Payables, where the payout method isn't assigned yet.

outRTPTransactionsinteger required

Count of payout transactions sent by real-time payments (RTP).

outRTPVolumenumber double required

Total value of RTP payouts, net of fees.

outWireTransactionsinteger required

Count of payout transactions sent by wire.

outWireVolumenumber double required

Total value of wire payouts, net of fees.

outTransactionsVolumenumber double required

Total payout value, net of fees.

outSubscriptionsPaidVolumenumber double required

Total value of recurring payouts, net of fees.

outCardVolumenumber double required

Total value of pCard payouts, net of fees.

outVCardVolumenumber double required

Total value of vCard payouts, net of fees.

outACHVolumenumber double required

Total value of ACH payouts, net of fees.

outCheckVolumenumber double required

Total value of check payouts, net of fees.

outPendingMethodVolumenumber double required

Total value of Managed Payables payouts, net of fees.

inTransactionsinteger required

Count of approved inbound (money in) transactions. This counts approved transactions only and leaves out declines. The payment method counts (inCardTransactions, inACHTransactions, inCheckTransactions, inCashTransactions, inWalletTransactions) are mutually exclusive and sum to this total.

inSubscriptionsPaidinteger required

Count of approved inbound transactions charged by a recurring schedule. This is a subset of inTransactions, not an amount to add on top of it.

inCustomersinteger required

Cumulative number of customers, as a running total through the end of this bucket rather than a per-bucket count.

inNewCustomersinteger required

Number of customers created during this bucket, scoped to the paypoint (level 2) or organization (level 0).

inCardTransactionsinteger required

Count of approved inbound card transactions, including card, cloud device, and in-person device payments.

inACHTransactionsinteger required

Count of approved inbound ACH transactions.

inCheckTransactionsinteger required

Count of approved inbound check transactions.

inCashTransactionsinteger required

Count of approved inbound cash transactions.

inWalletTransactionsinteger required

Count of approved inbound digital wallet transactions.

inCardChargeBacksinteger required

Count of card chargebacks recorded. Tracked separately from inACHReturns.

inACHReturnsinteger required

Count of ACH returns recorded.

inTransactionsVolumenumber double required

Total approved inbound value, net of fees.

inSubscriptionsPaidVolumenumber double required

Total value of approved recurring inbound transactions, net of fees.

inCardVolumenumber double required

Total approved card value, net of fees.

inACHVolumenumber double required

Total approved ACH value, net of fees.

inCheckVolumenumber double required

Total approved check value, net of fees.

inCashVolumenumber double required

Total approved cash value, net of fees.

inWalletVolumenumber double required

Total approved digital wallet value, net of fees.

inCardChargeBackVolumenumber double required

Total value of card chargebacks.

inACHReturnsVolumenumber double required

Total value of ACH returns.

Changes

No recorded changes to this operation across all 1 revision of this API.