> 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 payouts by org GET https://api-sandbox.payabli.com/api/Query/payouts/org/{orgId} Retrieves a list of money out transactions (payouts) for an organization. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/query/get-list-of-payouts-for-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 - `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) List of field names accepted: * status (in, nin, eq, ne) * transactionDate (gt, ge, lt, le, eq, ne) * billNumber (ct, nct) * vendorNumber (ct, nct, eq, ne) * vendorName (ct, nct, eq, ne) * parentOrgId (ne, eq, nin, in) * paymentMethod (ct, nct, eq, ne, in, nin) * paymentId (ct, nct, eq, ne) * batchNumber (ct, nct, eq, ne) * totalAmount (gt, ge, lt, le, eq, ne) * paypointLegal (ne, eq, ct, nct) * paypointDba (ne, eq, ct, nct) * accountId (ne, eq, ct, nct) * orgName (ne, eq, ct, nct) * externalPaypointID (ct, nct, eq, ne) * paypointId (eq, ne) * vendorId (eq, ne) * vendorEIN (ct, nct, eq, ne) * vendorPhone (ct, nct, eq, ne) * vendorEmail (ct, nct, eq, ne) * vendorAddress (ct, nct, eq, ne) * vendorCity (ct, nct, eq, ne) * vendorState (ct, nct, eq, ne) * vendorCountry (ct, nct, eq, ne) * vendorZip (ct, nct, eq, ne) * vendorMCC (ct, nct, eq, ne) * vendorLocationCode (ct, nct, eq, ne) * vendorCustomField1 (ct, nct, eq, ne) * vendorCustomField2 (ct, nct, eq, ne) * comments (ct, nct) * payaccountCurrency (ne, eq, in, nin) * remitAddress (ct, nct) * source (ct, nct, eq, ne) * updatedOn (gt, ge, lt, le, eq, ne) * feeAmount (gt, ge, lt, le, eq, ne) * lotNumber (ct, nct) * customerVendorAccount (ct, nct, eq, ne) * batchId (eq, ne) List of comparison accepted - enclosed between parentheses: * eq or empty => equal * gt => greater than * ge => greater or equal * lt => less than * le => less or equal * ne => not equal * ct => contains * nct => not contains * in => inside array separated by "|" * nin => not inside array separated by "|" List of parameters accepted: * limitRecord : max number of records for query (default="20", "0" or negative value for all) * fromRecord : initial record in query * sortBy : indicate field name and direction to sort the results Example: netAmount(gt)=20 returns all records with netAmount greater than 20.00 Example: sortBy=desc(netamount) returns all records sorted by netAmount descending - `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 QueryPayoutTransactionRecordsItem, optional) - `Summary` (QueryPayoutTransactionSummary, 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 ### QueryPayoutTransactionRecordsItem - `BatchNumber` (string, optional) — The batch number. - `Bills` (list of BillPayOutData, optional) — Events associated with this transaction. - `CardToken` (string, optional) - `CheckData` (FileContent, optional) — Object referencing paper check image. - `CheckNumber` (string, optional) — Paper check number related to payout transaction. - `Comments` (string, optional) — Any comment or description for payout transaction. - `CreatedAt` (datetime, optional) — Timestamp when the payment was created, in UTC. - `EntryName` (string, optional) — The entrypoint identifier. - `Events` (list of QueryTransactionEvents, optional) — Events associated with this transaction. - `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. - `FeeAmount` (double, optional) — Service fee or sub-charge applied. - `Gateway` (string, optional) — Gateway used to process the transaction. - `IdOut` (long, optional) — Identifier of payout transaction. - `LastUpdated` (datetime, optional) — Timestamp when payment record was updated. - `NetAmount` (double, optional) — Net amount paid. - `ParentOrgName` (string, optional) — The name of the parent organization. - `PaymentData` (QueryPayoutTransactionRecordsItemPaymentData, optional) - `PaymentId` (string, optional) — Unique transaction ID. - `PaymentMethod` (string, optional) — The payment method for the transaction. - `PaymentStatus` (string, optional) — Status of payout transaction. See [Payout Transaction Statuses](guides/money-out-statuses#payout-transaction-statuses) for a full reference. - `PaypointDbaname` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `PaypointLegalname` (string, optional) — Paypoint legal name. - `Source` (string, optional) — Custom identifier to indicate the transaction or request source. - `Status` (integer, optional) — Internal status of transaction. - `TotalAmount` (double, optional) — Transaction total amount (including service fee or sub-charge). - `Vendor` (VendorQueryRecord, optional) — Vendor related to the payout transaction. ### QueryPayoutTransactionSummary - `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) - `totalAuthorized` (integer, optional) - `totalAuthorizedAmount` (double, optional) - `totalCanceled` (integer, optional) - `totalCanceledAmount` (double, optional) - `totalCaptured` (integer, optional) - `totalCapturedAmount` (double, optional) - `totalNetAmount` (double, optional) - `totalOpen` (integer, optional) - `totalOpenAmount` (double, optional) - `totalPages` (integer, optional) - `totalPaid` (integer, optional) - `totalPaidAmount` (double, optional) - `totalProcessing` (integer, optional) - `totalProcessingAmount` (double, optional) - `totalRecords` (integer, optional) ### BillPayOutData - `AccountingField1` (string, optional) — Optional custom field. - `AccountingField2` (string, optional) — Optional custom field. - `AdditionalData` (string, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `attachments` (list of FileContent, optional) — Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly-accessible link. For full details on using this field with a payout authorization, see [the documentation](/developer-guides/pay-out-manage-payouts). - `billId` (long, optional) — Bill ID in Payabli. - `comments` (string, optional) — Any comments about bill. **For managed payouts, this field has a limit of 100 characters**. - `dueDate` (date, optional) — Bill due date in format YYYY-MM-DD or MM/DD/YYYY. - `invoiceDate` (date, optional) — Bill date in format YYYY-MM-DD or MM/DD/YYYY. - `invoiceNumber` (string, optional) — Custom number identifying the bill. Must be unique in paypoint. **Required** for new bill and when `billId` is not provided. - `netAmount` (string, optional) — Net Amount owed in bill. Required when adding a bill. - `Terms` (string, optional) — Description of payment terms. ### FileContent Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB. - `fContent` (string, optional) — Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB. - `filename` (string, optional) — The name of the attached file. - `ftype` (enum, optional) — The MIME type of the file (if content is provided) - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt` - `furl` (string, optional) — Optional url provided to show or download the file remotely ### QueryTransactionEvents - `EventData` (QueryTransactionEventsEventData, optional) — Any data associated to the event received from processor. Contents vary by event type. - `EventTime` (datetime, optional) — Date and time of event. - `TransEvent` (string, optional) — Event descriptor. See [TransEvent Reference](/references/transevents) for more details. ### QueryPayoutTransactionRecordsItemPaymentData - `AccountExp` (string, optional) — Expiration date of card used in transaction. - `accountId` (string, optional) — Custom identifier for payment connector. - `AccountType` (string, optional) — Bank account type or card brand. - `AccountZip` (string, optional) — ZIP code for card used in transaction. - `bankAccount` (string, optional) - `cloudSignatureData` (string, optional) - `cloudSignatureFormat` (string, optional) - `HolderName` (string, optional) — Card or bank account holder name. - `MaskedAccount` (string, optional) — Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number). - `orderDescription` (string, optional) — Text description of the transaction. - `paymentDetails` (PaymentDetail, optional) — Details about the payment. - `payorData` (string, optional) - `StoredId` (string, optional) — Identifier of stored payment method used in transaction. ### VendorQueryRecord - `additionalData` (map from string to map from string to any, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developer-guides/entities-custom-identifiers), pass those in this object. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `address1` (string, optional) — Vendor's address. - `address2` (string, optional) — Additional line for vendor's address. - `billingData` (BillingDataResponse, optional) - `city` (string, optional) — Vendor's city. - `contacts` (list of Contacts, optional) — List of contacts. - `country` (string, optional) — Vendor's country. - `createdDate` (datetime, optional) — Timestamp of when record was created, in UTC. - `customerVendorAccount` (string, optional) — Account number of paypoint in the vendor system. - `ein` (string, optional) — Business EIN or tax ID. This value is masked in API responses, for example `XXXX6789`. - `email` (string, optional) — Vendor's email address. - `enrollmentStatus` (string, optional) — Enrollment status of vendor in payables program. - `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. - `internalReferenceId` (long, optional) — Internal identifier for global vendor account. - `lastUpdated` (datetime, optional) — Timestamp of when record was last updated, in UTC. - `locationCode` (string, optional) — Additional location code used to identify the vendor. - `mcc` (string, optional) — Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv) lists MCC codes. - `name1` (string, optional) — Primary name for vendor. - `name2` (string, optional) — Secondary name for vendor. - `parentOrgName` (string, optional) — The name of the parent organization. - `payeeName1` (string, optional) — Alternative name used to receive paper check. - `payeeName2` (string, optional) — Alternative name used to receive paper check. - `paymentMethod` (VendorPaymentMethod, optional) — Object containing details about the payment method to use for the payout. - `paypointDbaname` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `paypointEntryname` (string, optional) — The entrypoint identifier. - `paypointLegalname` (string, optional) — Business legal name. - `phone` (string, optional) — Vendor's phone number. - `remitAddress1` (string, optional) — Remittance address. Used for mailing paper checks. - `remitAddress2` (string, optional) — Remittance address additional line. Used for mailing paper checks. - `remitCity` (string, optional) — Remittance address city. Used for mailing paper checks. - `remitCountry` (string, optional) — Remittance address country. Used for mailing paper checks. - `remitState` (string, optional) — Remittance address state. Used for mailing paper checks. - `remitZip` (string, optional) — Remittance address ZIP code. Used for mailing paper checks. - `state` (string, optional) — Vendor's state. - `summary` (VendorSummary, optional) - `vendorId` (integer, optional) — Payabli identifier for vendor record. - `vendorNumber` (string, optional) — Custom number identifying the vendor. Must be unique in paypoint. - `vendorStatus` (integer, optional) — Vendor's status. Allowed status: - 0 Inactive - 1 Active - `zip` (string, optional) — Vendor's zip code. ### QueryTransactionEventsEventData Any data associated to the event received from processor. Contents vary by event type. ### PaymentDetail Details about the payment. - `totalAmount` (double, required) — Total amount to be charged. If a service fee is sent, then this amount should include the service fee." - `categories` (list of PaymentCategories, optional) — Array of payment categories/line items describing the amount to be paid **Note**: These categories are for information only and are not validated against the total amount provided. - `checkImage` (map from string to any, optional) — Object containing image of paper check. - `checkNumber` (string, optional) — A check number to be used in the ach transaction. **Required** for payment method = 'check'. - `currency` (string, optional) — Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is **USD**. - `serviceFee` (double, optional) — Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually. - `splitFunding` (list of SplitFundingContent, optional) — Split funding instructions for the transaction. See [Split a Transaction](/developer-guides/money-in-split-funding) for more. ### BillingDataResponse - `accountNumber` (string, optional) — Masked account number for bank account. - `bankAccountFunction` (integer, optional) — Describes whether the bank account is used for deposits or withdrawals in Payabli: - `0`: Deposit - `1`: Withdrawal - `2`: Deposit and withdrawal - `bankAccountHolderName` (string, optional) — The accountholder's name. - `bankAccountHolderType` (enum, optional) — Describes whether the bank is a personal or business account. - Allowed values: `Personal`, `Business` - `bankName` (string, optional) — Name of bank for account. - `id` (integer, optional) — The bank's ID in Payabli. - `routingAccount` (string, optional) — Routing number of bank account. - `typeAccount` (enum, optional) — Type of bank account: Checking or Savings. - Allowed values: `Checking`, `Savings` ### Contacts - `contactEmail` (string, optional) — Contact email address. - `contactName` (string, optional) — Contact name. - `contactPhone` (string, optional) — Contact phone number. - `contactTitle` (string, optional) — Contact title. ### VendorPaymentMethod Object containing details about the payment method to use for the payout. - `method` (enum, optional) — Payment method to use for payout. Leave empty for managed payables. - Allowed values: `managed`, `vcard`, `ach`, `check` ### VendorSummary - `inTransitBills` (integer, optional) - `inTransitBillsAmount` (double, optional) - `overdueBills` (integer, optional) - `overdueBillsAmount` (double, optional) - `paidBills` (integer, optional) - `paidBillsAmount` (double, optional) - `pendingBills` (integer, optional) - `pendingBillsAmount` (double, optional) - `totalBills` (integer, optional) - `totalBillsAmount` (double, optional) ### PaymentCategories - `amount` (double, required) — Price/cost per unit of item or category. - `label` (string, required) — Name of item or category. - `description` (string, optional) — Description of item or category - `qty` (integer, optional, default: 1) — Quatity of item or category ### SplitFundingContent - `accountId` (string, optional) — The accountId for the account the split should be sent to. - `amount` (double, optional) — Amount from the transaction to sent to this recipient. - `description` (string, optional) — A description for the split. - `recipientEntryPoint` (string, optional) — The entrypoint the split should be sent to. ## Examples **Response** ```json { "Records": [ { "BatchNumber": "BT-2024321", "Bills": [ {} ], "CardToken": "CardToken", "CheckNumber": "12345", "Comments": "Deposit for materials", "CreatedAt": "2022-07-01T15:00:01Z", "EntryName": "d193cf9a46", "Events": [ {} ], "externalPaypointID": "Paypoint-100", "FeeAmount": 10.25, "Gateway": "TSYS", "IdOut": 236, "LastUpdated": "2022-07-01T15:00:01Z", "NetAmount": 3762.87, "ParentOrgName": "PropertyManager Pro", "PaymentData": { "paymentDetails": { "totalAmount": 100 } }, "PaymentId": "2345667-ddd-fff", "PaymentMethod": "ach", "PaymentStatus": "Processed", "PaypointDbaname": "Sunshine Gutters", "PaypointLegalname": "Sunshine Services, LLC", "Source": "api", "Status": 1, "TotalAmount": 110.25, "Vendor": { "additionalData": { "key1": { "key": "value" }, "key2": { "key": "value" }, "key3": { "key": "value" } }, "createdDate": "2022-07-01T15:00:01Z" } } ], "Summary": { "pageIdentifier": "null", "pageSize": 20, "totalAmount": 1.1, "totalAuthorized": 1, "totalAuthorizedAmount": 1.1, "totalCanceled": 1, "totalCanceledAmount": 1.1, "totalCaptured": 1, "totalCapturedAmount": 1.1, "totalNetAmount": 1.1, "totalOpen": 1, "totalOpenAmount": 1.1, "totalPages": 1, "totalPaid": 1, "totalPaidAmount": 1.1, "totalProcessing": 1, "totalProcessingAmount": 1.1, "totalRecords": 1 } } ``` **SDK Code** ```python import requests url = "https://api-sandbox.payabli.com/api/Query/payouts/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/payouts/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/payouts/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/payouts/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/payouts/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/payouts/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/payouts/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/payouts/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() ```