> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://useroot.docs.buildwithfern.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://useroot.docs.buildwithfern.com/_mcp/server. # List payouts GET https://api.useroot.com/api/payouts Retrieves a paginated list of payouts. Supports filtering by various criteria including payee name, amount range, creation date, rail type, status, and subaccount. **Filter parameters:** `amount_gte` and `amount_lte` filter by payout amount in the smallest unit of the currency (same semantics as `amount_in_minor_units`; for USD, values are in cents). **Success Responses** | Status Code | Description | | ----------- | --------------------------------------------------- | | 200 | OK - The list of payouts was successfully retrieved | **Error Responses** | Status Code | Error Code | Description | | ----------- | ----------------------- | ------------------------------------------------- | | 400 | VALIDATION\_ERROR | The provided query parameters failed validation | | 400 | INVALID\_STATUS\_VALUES | One or more invalid status values were provided | | 401 | AUTHENTICATION\_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION\_ERROR | You do not have permission to perform this action | **Example Error Response for Invalid Status** ```http { "error_code": "INVALID_STATUS_VALUES", "message": "Invalid status values: invalid_status, another_invalid", "details": { "invalid_statuses": ["invalid_status", "another_invalid"], "valid_statuses": ["approved", "canceled", "created", "debited", "failed", "initiated", "settled"] } } ``` Reference: https://useroot.docs.buildwithfern.com/api-reference/payouts-api/list-all-payouts ## Authentication - `x-api-key` header (required) — RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox. ## Request ### Query parameters - `cursor` (string, optional, nullable) — Cursor for pagination. Use the next_cursor from the previous response to get the next page. - `limit` (integer, optional, nullable, default: 50) — Number of items to return per page. Maximum is 500. - `payee_name` (string, optional, nullable) — Filter payouts by a case-insensitive substring match on the payee's name. - `amount_gte` (integer, optional, nullable) — Return payouts whose amount_in_cents is greater than or equal to this value (in cents). - `amount_lte` (integer, optional, nullable) — Return payouts whose amount_in_cents is less than or equal to this value (in cents). - `created_at_gte` (datetime, optional, nullable) — Return payouts created on or after this date (YYYY-MM-DD). - `created_at_lte` (datetime, optional, nullable) — Return payouts created on or before this date (YYYY-MM-DD). - `rail` (list of enum, optional, nullable) — Filter by rail (standard_ach, same_day_ach, instant_bank, instant_card). Can provide multiple rails as separate parameters (e.g., ?rail=instant_card&rail=instant_bank). - Allowed values: `instant_card`, `instant_bank`, `same_day_ach`, `standard_ach`, `wire`, `{'instant_card', 'instant_bank'}`, `{'standard_ach', 'same_day_ach'}`, `{'standard_ach', 'wire'}` - `status` (list of enum, optional, nullable) — Filter by the payout's latest status. Can provide multiple statuses as separate parameters (e.g., ?status=created&status=approved). Valid values: created, approved, initiated, debited, settled, failed, canceled. - Allowed values: `created`, `approved`, `initiated`, `debited`, `settled`, `failed`, `canceled` - `order` (enum, optional, nullable, default: desc) — Sort order by created_at: 'asc' for oldest first, 'desc' for newest first (default: 'desc') - Allowed values: `desc`, `asc` - `subaccount_id` (string, optional, nullable) — Filter payouts by subaccount ID. Only returns payouts associated with the specified subaccount. ## Response ### 200 List of payouts retrieved successfully - `data` (list of object, required) - `created_at` (datetime, required) - `updated_at` (datetime, required) - `id` (string, required) - `payee_id` (string, required) - `amount_in_minor_units` (integer, required) — Amount in the currency's minor units (e.g. cents for USD). - `currency_code` (enum, required) - Allowed values: `USD`, `GBP`, `INR` - `country_code` (enum, required) - Allowed values: `US`, `GB`, `IN` - `rail` (enum, required) - Allowed values: `instant_card`, `instant_bank`, `same_day_ach`, `standard_ach`, `wire`, `{'instant_card', 'instant_bank'}`, `{'standard_ach', 'same_day_ach'}`, `{'standard_ach', 'wire'}` - `payout_metadata` (map from string to any, required) - `status` (enum, required) — Current status of the payout. One of: created, approved, initiated, debited, settled, failed, canceled. - Allowed values: `created`, `approved`, `initiated`, `debited`, `settled`, `failed`, `canceled` - `status_recorded_at` (datetime, required) - `amount_in_cents` (integer, required, deprecated) — Deprecated. Use amount_in_minor_units instead. Still accepted and returned for backward compatibility. - `client_metadata` (map from string to string, optional) - `scheduled_date` (date, optional, nullable) — Caller-chosen send day in the schedule timezone (currently America/New_York), or null when immediate. - `has_more` (boolean, required) - `total_count` (integer, optional, nullable, default: 0) - `next_cursor` (string, optional, nullable) - `previous_cursor` (string, optional, nullable) ## Examples **Response** ```json { "data": [ { "created_at": "2024-03-20T12:00:00Z", "updated_at": "2024-03-20T12:00:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "payee_id": "123e4567-e89b-12d3-a456-426614174001", "amount_in_minor_units": 10000, "currency_code": "USD", "country_code": "US", "rail": "instant_bank", "payout_metadata": { "payment_method": { "account_last_four": "7890", "routing_number": "021000021" }, "payee": { "name": "Jane Doe", "email": "jane.doe@example.com" } }, "status": "created", "status_recorded_at": "2024-03-20T12:00:00Z", "amount_in_cents": 10000 }, { "created_at": "2024-03-20T12:00:00Z", "updated_at": "2024-03-20T12:00:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "payee_id": "123e4567-e89b-12d3-a456-426614174001", "amount_in_minor_units": 10000, "currency_code": "USD", "country_code": "US", "rail": "instant_bank", "payout_metadata": { "payment_method": { "account_last_four": "7890", "routing_number": "021000021", "end_to_end_id": "RTP20240320123456789" }, "payee": { "name": "Jane Doe", "email": "jane.doe@example.com" } }, "status": "initiated", "status_recorded_at": "2024-03-20T12:01:00Z", "amount_in_cents": 10000 }, { "created_at": "2024-03-20T12:00:00Z", "updated_at": "2024-03-20T12:00:00Z", "id": "123e4567-e89b-12d3-a456-426614174002", "payee_id": "123e4567-e89b-12d3-a456-426614174001", "amount_in_minor_units": 10000, "currency_code": "USD", "country_code": "US", "rail": "instant_card", "payout_metadata": { "payment_method": { "card_last_four": "1111", "card_expiry_date": "2512" }, "payee": { "name": "Jane Doe", "email": "jane.doe@example.com" } }, "status": "created", "status_recorded_at": "2024-03-20T12:00:00Z", "amount_in_cents": 10000 }, { "created_at": "2024-03-20T12:00:00Z", "updated_at": "2024-03-20T12:00:00Z", "id": "123e4567-e89b-12d3-a456-426614174002", "payee_id": "123e4567-e89b-12d3-a456-426614174001", "amount_in_minor_units": 10000, "currency_code": "USD", "country_code": "US", "rail": "instant_card", "payout_metadata": { "payment_method": { "card_last_four": "1111", "card_expiry_date": "2512", "end_to_end_id": "CARD20240320123456789" }, "payee": { "name": "Jane Doe", "email": "jane.doe@example.com" } }, "status": "initiated", "status_recorded_at": "2024-03-20T12:01:00Z", "amount_in_cents": 10000 } ], "has_more": false, "total_count": 4 } ``` **SDK Code** ```python List of payouts import requests url = "https://api.useroot.com/api/payouts" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript List of payouts const url = 'https://api.useroot.com/api/payouts'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go List of payouts package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.useroot.com/api/payouts" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby List of payouts require 'uri' require 'net/http' url = URI("https://api.useroot.com/api/payouts") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java List of payouts import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.useroot.com/api/payouts") .header("x-api-key", "") .asString(); ``` ```php List of payouts request('GET', 'https://api.useroot.com/api/payouts', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp List of payouts using RestSharp; var client = new RestClient("https://api.useroot.com/api/payouts"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift List of payouts import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payouts")! 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() ```