> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://beta-docs.payabli.com/api-reference/get-basic-statistics-for-a-paypoint-or-organization/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # Get stats for an org or paypoint GET https://api-sandbox.payabli.com/api/Statistic/basic/{mode}/{freq}/{level}/{entryId} Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency. Reference: https://beta-docs.payabli.com/api-reference/get-basic-statistics-for-a-paypoint-or-organization ## Authentication - `requestToken` header (required) — API Key authentication via header ## Servers - `https://api-sandbox.payabli.com/api` (Sandbox, default) - `https://api.payabli.com/api` (Production) ## Request ### Path parameters - `entryId` (long, required) — Identifier in Payabli for the entity. - `freq` (string, required) — Frequency to group series. Allowed values: - `m` - monthly - `w` - weekly - `d` - daily - `h` - hourly For example, `w` groups the results by week. - `level` (integer, required) — The entry level for the request: - 0 for Organization - 2 for Paypoint - `mode` (string, 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 - `endDate` (string, optional) — Used with `custom` mode. The end date for the range. Valid formats: - YYYY-mm-dd - YYYY/mm/dd - mm-dd-YYYY - mm/dd/YYYY - `parameters` (map from string to string, optional) — List of parameters. - `startDate` (string, optional) — 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 ### 200 Success - `list of StatBasicQueryRecord` ## Errors ### 400 Bad Request Error Bad request/ invalid data - `any` ### 401 Unauthorized Error Unauthorized request. - `any` ### 500 Internal Server Error Internal API Error - `any` ### 503 Service Unavailable Error Database connection error - `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure. - `responseData` (map from string to any, optional) — The object containing the response data. - `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'. ## Types ### StatBasicQueryRecord - `additionalProperties` (any, optional) - `inACHReturns` (integer, optional) - `inACHReturnsVolume` (double, optional) - `inACHTransactions` (integer, optional) - `inACHVolume` (double, optional) - `inCardChargeBacks` (integer, optional) - `inCardChargeBackVolume` (double, optional) - `inCardTransactions` (integer, optional) - `inCardVolume` (double, optional) - `inCashTransactions` (integer, optional) - `inCashVolume` (double, optional) - `inCheckTransactions` (integer, optional) - `inCheckVolume` (double, optional) - `inCustomers` (integer, optional) - `inNewCustomers` (integer, optional) - `inSubscriptionsPaid` (integer, optional) - `inSubscriptionsPaidVolume` (double, optional) - `inTransactions` (integer, optional) - `inTransactionsVolume` (double, optional) - `outACHTransactions` (integer, optional) - `outACHVolume` (double, optional) - `outCardTransactions` (integer, optional) - `outCardVolume` (double, optional) - `outCheckTransactions` (integer, optional) - `outCheckVolume` (double, optional) - `outCustomers` (integer, optional) - `outNewCustomers` (integer, optional) - `outSubscriptionsPaid` (integer, optional) - `outSubscriptionsPaidVolume` (double, optional) - `outTransactions` (integer, optional) - `outTransactionsVolume` (double, optional) - `outVCardTransactions` (integer, optional) - `outVCardVolume` (double, optional) - `statX` (string, optional) ## Examples **Response** ```json [ { "additionalProperties": { "key": "value" }, "inACHReturns": 1, "inACHReturnsVolume": 1.1, "inACHTransactions": 1, "inACHVolume": 1.1, "inCardChargeBacks": 1, "inCardChargeBackVolume": 1.1, "inCardTransactions": 1, "inCardVolume": 1.1, "inCashTransactions": 1, "inCashVolume": 1.1, "inCheckTransactions": 1, "inCheckVolume": 1.1, "inCustomers": 1, "inNewCustomers": 1, "inSubscriptionsPaid": 1, "inSubscriptionsPaidVolume": 1.1, "inTransactions": 1, "inTransactionsVolume": 1.1, "outACHTransactions": 1, "outACHVolume": 1.1, "outCardTransactions": 1, "outCardVolume": 1.1, "outCheckTransactions": 1, "outCheckVolume": 1.1, "outCustomers": 1, "outNewCustomers": 1, "outSubscriptionsPaid": 1, "outSubscriptionsPaidVolume": 1.1, "outTransactions": 1, "outTransactionsVolume": 1.1, "outVCardTransactions": 1, "outVCardVolume": 1.1, "statX": "statX" } ] ``` **SDK Code** ```python import requests url = "https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000" querystring = {"endDate":"2023-05-23","startDate":"2023-03-23"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000?endDate=2023-05-23&startDate=2023-03-23'; const options = {method: 'GET', headers: {requestToken: ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000?endDate=2023-05-23&startDate=2023-03-23" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("requestToken", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000?endDate=2023-05-23&startDate=2023-03-23") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000?endDate=2023-05-23&startDate=2023-03-23") .header("requestToken", "") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000?endDate=2023-05-23&startDate=2023-03-23', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000?endDate=2023-05-23&startDate=2023-03-23"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000?endDate=2023-05-23&startDate=2023-03-23")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` > If you're a software company, you're a payments company™