> 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/query/get-list-of-moneyout-batches-for-an-org/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # List payout batches for org GET https://api-sandbox.payabli.com/api/Query/batchesOut/org/{orgId} Retrieve a list of MoneyOut batches for an org. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/query/get-list-of-moneyout-batches-for-an-org ## 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 - `orgId` (integer, required) — The numeric identifier for organization, assigned by Payabli. ### 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) * batchAmount (gt, ge, lt, le, eq, ne) * parentOrgId (ne, eq, nin, in) * status (in, nin, eq, ne) * orgId (eq) * paypointLegal (ne, eq, ct, nct) * paypointDba (ne, eq, ct, nct) * orgName (ne, eq, ct, nct) * paypointId (ne, eq) * externalPaypointID (ct, nct, eq, ne) - `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 QueryBatchesOutResponseRecordsItem, optional) - `Summary` (BatchSummary, optional) ## Errors ### 400 Bad Request Error Bad request/ invalid data - `any` ### 401 Unauthorized Error Unauthorized request. - `any` ### 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 ### QueryBatchesOutResponseRecordsItem - `AchAmount` (double, optional) - `AchRecords` (integer, optional) - `AchStatus` (integer, optional) - `AchStatusText` (string, optional) - `BatchAmount` (double, optional) — The amount of the batch. - `BatchCancelledAmount` (double, optional) - `BatchCancelledRecords` (integer, optional) - `BatchDate` (datetime, optional) — The batch date. - `BatchNumber` (string, optional) — The batch number. - `BatchPaidAmount` (double, optional) - `BatchPaidRecords` (integer, optional) - `BatchProcessedAmount` (double, optional) - `BatchProcessedRecords` (integer, optional) - `BatchProcessingAmount` (double, optional) - `BatchProcessingRecords` (integer, optional) - `BatchRecords` (integer, optional) — The number of records in the batch. - `BatchStatus` (integer, optional) — The batch status. See [Batch Status](/references/money-out-statuses#batch-statuses) for more. - `BatchStatusText` (string, optional) — A text description of the batch status. - `CardAmount` (double, optional) - `CardRecords` (integer, optional) - `CardStatus` (integer, optional) - `CardStatusText` (string, optional) - `CheckAmount` (double, optional) - `CheckRecords` (integer, optional) - `CheckStatus` (integer, optional) - `CheckStatusText` (string, optional) - `EntryName` (string, optional) — The entrypoint identifier. - `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. - `ParentOrgName` (string, optional) — The entrypoint's parent org. - `PaypointDba` (string, optional) — Paypoint DBA name. - `PaypointId` (integer, optional) — Paypoint ID. - `PaypointName` (string, optional) — Paypoint legal name. - `VcardAmount` (double, optional) - `VcardRecords` (integer, optional) - `VcardStatus` (integer, optional) - `VcardStatusText` (string, optional) - `WireAmount` (double, optional) - `WireRecords` (integer, optional) - `WireStatus` (integer, optional) - `WireStatusText` (string, optional) ### 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": [ { "AchAmount": 0, "AchRecords": 0, "AchStatus": 0, "AchStatusText": "AchStatusText", "BatchAmount": 4, "BatchCancelledAmount": 0, "BatchCancelledRecords": 0, "BatchDate": "2024-01-01T00:00:00Z", "BatchNumber": "10-20240101-PAYABLITST", "BatchPaidAmount": 0, "BatchPaidRecords": 0, "BatchProcessedAmount": 0, "BatchProcessedRecords": 0, "BatchProcessingAmount": 0, "BatchProcessingRecords": 0, "BatchRecords": 1, "BatchStatus": 1, "BatchStatusText": "Waiting Funds", "CardAmount": 0, "CardRecords": 0, "CardStatus": 0, "CardStatusText": "CardStatusText", "CheckAmount": 0, "CheckRecords": 0, "CheckStatus": 0, "CheckStatusText": "CheckStatusText", "EntryName": "d193cf9a46", "externalPaypointID": "Paypoint-100", "IdBatch": 239, "ParentOrgName": "FitnessManager", "PaypointDba": "Athlete Factory LLC", "PaypointId": 123, "PaypointName": "Athlete Factory LLC", "VcardAmount": 0, "VcardRecords": 0, "VcardStatus": 0, "VcardStatusText": "VcardStatusText", "WireAmount": 0, "WireRecords": 0, "WireStatus": 0, "WireStatusText": "WireStatusText" } ], "Summary": { "pageidentifier": "null", "pageSize": 20, "totalAmount": 0.01, "totalNetAmount": 0, "totalPages": 1, "totalRecords": 46 } } ``` **SDK Code** ```python import requests url = "https://api-sandbox.payabli.com/api/Query/batchesOut/org/123" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api-sandbox.payabli.com/api/Query/batchesOut/org/123?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 package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/batchesOut/org/123?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 require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/batchesOut/org/123?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 import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/batchesOut/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/batchesOut/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/batchesOut/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); 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/Query/batchesOut/org/123?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() ``` > If you're a software company, you're a payments company™