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