> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://beta-docs.payabli.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # List batches for paypoint GET https://api-sandbox.payabli.com/api/Query/batches/{entry} Retrieve a list of batches for a paypoint. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/query/get-list-of-batches-for-an-entrypoint ## 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 - `entry` (string, required) — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry) ### Query parameters - `fromRecord` (integer, optional, default: 0) — The number of records to skip before starting to collect the result set. - `limitRecord` (integer, optional, default: 20) — Max number of records to return for the query. Use `0` or negative value to return all records. - `parameters` (map from string to string, optional) — Collection of field names, conditions, and values used to filter the query. **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.** Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. For example: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount\(gt\)=1000\&limitRecord=20) should become: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount\(gt\)=1000\&limitRecord=20) See [Filters and Conditions Reference](/developer-guides/reporting-filters-and-conditions-reference) for more information. **List of field names accepted:** * `batchDate` (gt, ge, lt, le, eq, ne) * `batchNumber` (ne, eq) * `method` (in, nin, eq, ne) * `connectorName` (ne, eq, ct, nct) * `batchAmount` (gt, ge, lt, le, eq, ne) * `feeBatchAmount` (gt, ge, lt, le, eq, ne) * `netBatchAmount` (gt, ge, lt, le, eq, ne) * `releaseAmount` (gt, ge, lt, le, eq, ne) * `heldAmount` (gt, ge, lt, le, eq, ne) * `status` (in, nin, eq, ne) * `paypointLegal` (ne, eq, ct, nct) * `paypointDba` (ne, eq, ct, nct) * `orgName` (ne, eq, ct, nct) * `paypointId` (ne, eq) * `externalPaypointID` (ct, nct, eq, ne) * `expectedDepositDate` (gt, ge, lt, le, eq, ne) * `depositDate` (gt, ge, lt, le, eq, ne) * `batchRecords` (gt, ge, lt, le, eq, ne) * `transferId` (ne, eq) * `transferDate` (gt, ge, lt, le, eq, ne) * `grossAmount` (gt, ge, lt, le, eq, ne) * `chargeBackAmount` (gt, ge, lt, le, eq, ne) * `returnedAmount` (gt, ge, lt, le, eq, ne) * `billingFeeAmount` (gt, ge, lt, le, eq, ne) * `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne) * `netFundedAmount` (gt, ge, lt, le, eq, ne) * `adjustmentAmount` (gt, ge, lt, le, eq, ne) * `processor` (ne, eq, ct, nct) * `transferStatus` (ne, eq, in, nin) **List of parameters accepted:** * `limitRecord`: max number of records for query (default="20", "0" or negative value for all) * `fromRecord`: initial record in query Example: `batchAmount(gt)=20` returns all records with batchAmount greater than 20.00 - `sortBy` (string, optional) — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. ## Response ### 200 Success - `Records` (list of QueryBatchesResponseRecordsItem, optional) - `Summary` (BatchSummary, optional) ## 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 ### QueryBatchesResponseRecordsItem - `BatchAmount` (double, optional) — The amount of the batch. - `BatchAuthAmount` (double, optional) - `BatchDate` (datetime, optional) — The batch date. - `BatchFeesAmount` (double, optional) — The total of fees in the batch. - `BatchHoldAmount` (double, optional) — The total amount of the batch that is being held for fraud or risk concerns. - `BatchNumber` (string, optional) — The batch number. - `BatchRecords` (integer, optional) — The number of records in the batch. - `BatchRefundAmount` (double, optional) — The total amount of refunds deducted from batch. - `BatchReleasedAmount` (double, optional) — Previously held funds that have been released after a risk review. - `BatchReturnedAmount` (double, optional) — Total amount of ACH returns deducted from batch. - `BatchSplitAmount` (double, optional) — Total of split transactions that included split funding instructions at the time of authorization. - `BatchStatus` (integer, optional) — The batch status. See [Batch Status](/references/money-in-statuses#batch-status) for more. - `ConnectorName` (string, optional) - `DepositDate` (datetime, optional) — The date the funds were deposited. - `EntryName` (string, optional) — The entrypoint identifier. - `ExpectedDepositDate` (datetime, optional) — The date the funds are expected to be deposited. - `externalPaypointID` (string, optional) — A custom identifier for the paypoint, if applicable. Like `entrypoint` is the Payabli identifier for the merchant, `externalPaypointId` is a custom field you can use to include the merchant's ID from your own systems. - `IdBatch` (integer, optional) — The batch ID. - `Method` (string, optional) — The payment method used. - `ParentOrgName` (string, optional) — The entrypoint's parent org. - `PaypointDba` (string, optional) — Paypoint DBA name. - `PaypointId` (long, optional) — The paypoint's ID. Note that this is different than the entryname. - `PaypointName` (string, optional) — Paypoint legal name. - `Transfer` (string, optional) - `TransferDate` (datetime, optional) — The batch transfer date. ### BatchSummary - `pageidentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSize` (integer, optional) — Number of records on each response page. - `totalAmount` (double, optional) — Total amount for the records. - `totalNetAmount` (double, optional) — Total net amount for the records. - `totalPages` (integer, optional) — Total number of pages in response. - `totalRecords` (integer, optional) — Total number of records in response. ## Examples **Response** ```json { "Records": [ { "BatchAmount": 0, "BatchAuthAmount": 0, "BatchDate": "2023-04-19T19:01:05Z", "BatchFeesAmount": 0, "BatchHoldAmount": 0, "BatchNumber": "BT-2023041919-187", "BatchRecords": 2, "BatchRefundAmount": 0, "BatchReleasedAmount": 0, "BatchReturnedAmount": 0, "BatchSplitAmount": 0, "BatchStatus": 2, "ConnectorName": "", "EntryName": "d193cf9a46", "ExpectedDepositDate": "2023-04-20T00:00:00Z", "externalPaypointID": "", "IdBatch": 1049, "Method": "card", "ParentOrgName": "PayabliDemoAccount(PB)", "PaypointDba": "The Board Haus", "PaypointId": 187, "PaypointName": "Board Haus LLC.", "TransferDate": "2025-09-02T00:00:00Z" }, { "BatchAmount": 219.02, "BatchAuthAmount": 0, "BatchDate": "2023-04-18T17:01:03Z", "BatchFeesAmount": 0, "BatchHoldAmount": 0, "BatchNumber": "BT-2023041817-187", "BatchRecords": 1, "BatchRefundAmount": 0, "BatchReleasedAmount": 0, "BatchReturnedAmount": 0, "BatchSplitAmount": 0, "BatchStatus": 2, "ConnectorName": "", "EntryName": "d193cf9a46", "ExpectedDepositDate": "2023-04-19T00:00:00Z", "externalPaypointID": "", "IdBatch": 1043, "Method": "card", "ParentOrgName": "PayabliDemoAccount(PB)", "PaypointDba": "The Board Haus", "PaypointId": 187, "PaypointName": "Board Haus LLC.", "TransferDate": "2025-09-02T00:00:00Z" }, { "BatchAmount": 1080.44, "BatchAuthAmount": 0, "BatchDate": "2023-04-14T21:01:03Z", "BatchFeesAmount": 0, "BatchHoldAmount": 0, "BatchNumber": "BT-2023041421-187", "BatchRecords": 4, "BatchRefundAmount": 0, "BatchReleasedAmount": 0, "BatchReturnedAmount": 0, "BatchSplitAmount": 0, "BatchStatus": 2, "ConnectorName": "", "EntryName": "d193cf9a46", "ExpectedDepositDate": "2023-04-15T00:00:00Z", "externalPaypointID": "", "IdBatch": 1012, "Method": "card", "ParentOrgName": "PayabliDemoAccount(PB)", "PaypointDba": "The Board Haus", "PaypointId": 187, "PaypointName": "Board Haus LLC.", "TransferDate": "2025-09-02T00:00:00Z" } ], "Summary": { "pageidentifier": "XXXXXXXXXXXXXXXXX", "pageSize": 20, "totalAmount": 54049.71, "totalNetAmount": 0, "totalPages": 3, "totalRecords": 3 } } ``` **SDK Code** ```python Example Response import requests url = "https://api-sandbox.payabli.com/api/Query/batches/8cfec329267" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Example Response const url = 'https://api-sandbox.payabli.com/api/Query/batches/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29'; 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 Example Response package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/batches/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29" 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 Example Response require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/batches/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") 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 Example Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/batches/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php Example Response request('GET', 'https://api-sandbox.payabli.com/api/Query/batches/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp Example Response using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/batches/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift Example Response import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/batches/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! 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() ```