Skip to navigation
APIPay Ops endpointsBusiness entities

Get stats for an org or paypoint

View as MarkdownOpen in Claude
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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token 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
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 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

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

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

outTransactionsinteger

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
Count of payout transactions generated by a recurring schedule.
outCardTransactionsinteger
Count of payout transactions sent by pCard.
outVCardTransactionsinteger

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

outACHTransactionsinteger
Count of payout transactions sent by ACH.
outCheckTransactionsinteger
Count of payout transactions sent by check.
outPendingMethodTransactionsinteger
Count of payout transactions held as Managed Payables, where the payout method isn't assigned yet.
outRTPTransactionsinteger

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

outRTPVolumedouble
Total value of RTP payouts, net of fees.
outWireTransactionsinteger
Count of payout transactions sent by wire.
outWireVolumedouble
Total value of wire payouts, net of fees.
outTransactionsVolumedouble
Total payout value, net of fees.
outSubscriptionsPaidVolumedouble
Total value of recurring payouts, net of fees.
outCardVolumedouble
Total value of pCard payouts, net of fees.
outVCardVolumedouble
Total value of vCard payouts, net of fees.
outACHVolumedouble
Total value of ACH payouts, net of fees.
outCheckVolumedouble
Total value of check payouts, net of fees.
outPendingMethodVolumedouble
Total value of Managed Payables payouts, net of fees.
inTransactionsinteger

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

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

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

inNewCustomersinteger

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

inCardTransactionsinteger

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

inACHTransactionsinteger
Count of approved inbound ACH transactions.
inCheckTransactionsinteger
Count of approved inbound check transactions.
inCashTransactionsinteger
Count of approved inbound cash transactions.
inWalletTransactionsinteger
Count of approved inbound digital wallet transactions.
inCardChargeBacksinteger

Count of card chargebacks recorded. Tracked separately from inACHReturns.

inACHReturnsinteger
Count of ACH returns recorded.
inTransactionsVolumedouble
Total approved inbound value, net of fees.
inSubscriptionsPaidVolumedouble
Total value of approved recurring inbound transactions, net of fees.
inCardVolumedouble
Total approved card value, net of fees.
inACHVolumedouble
Total approved ACH value, net of fees.
inCheckVolumedouble
Total approved check value, net of fees.
inCashVolumedouble
Total approved cash value, net of fees.
inWalletVolumedouble
Total approved digital wallet value, net of fees.
inCardChargeBackVolumedouble
Total value of card chargebacks.
inACHReturnsVolumedouble
Total value of ACH returns.

Errors

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