> ## Documentation Index > Fetch the complete documentation index at: https://docs.withflex.com/llms.txt > Use this file to discover all available pages before exploring further. # List Payouts > Returns a list of payouts. ## OpenAPI ````yaml /openapi.json get /v1/payouts openapi: 3.1.0 info: title: Flex API description: >- The Flex API powers HSA/FSA payment processing for healthcare commerce: checkout sessions, payment intents, subscriptions, customers, refunds, disputes, and eligibility. Authenticate with your partner API key as a Bearer token. All endpoints are scoped to your partner account, and test mode is fully supported via test API keys. version: 0.1.0 servers: - url: https://api.withflex.com security: - BearerAuth: [] tags: - name: Balance Transactions - name: Captures - name: Checkout Sessions - name: Coupons - name: Customers - name: Disputes - name: Events - name: Exports - name: Files - name: Invoices - name: Letters - name: Orders - name: Payment Intents - name: Payment Links - name: Payouts - name: Prices - name: Products - name: Promo Codes - name: Receipts - name: Refunds - name: Setup Intents - name: Shipping Rates - name: Subscriptions paths: /v1/payouts: get: tags: - Payouts summary: List Payouts description: Returns a list of payouts. operationId: v1.payouts.list parameters: - in: query name: payout_id description: Filter by a specific payout ID. schema: description: Filter by a specific payout ID. examples: - fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA type: - string - 'null' style: form example: fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA - in: query name: start_date description: >- Filter payouts created after this date (ISO 8601 format: 2023-10-01T00:00:00Z). schema: description: >- Filter payouts created after this date (ISO 8601 format: 2023-10-01T00:00:00Z). examples: - '2026-06-15T14:30:00Z' anyOf: - $ref: '#/components/schemas/Timestamptz' - type: 'null' style: form example: '2026-06-15T14:30:00Z' - in: query name: end_date description: >- Filter payouts created before this date (ISO 8601 format: 2023-10-01T00:00:00Z). schema: description: >- Filter payouts created before this date (ISO 8601 format: 2023-10-01T00:00:00Z). examples: - '2026-06-15T14:30:00Z' anyOf: - $ref: '#/components/schemas/Timestamptz' - type: 'null' style: form example: '2026-06-15T14:30:00Z' - in: query name: limit description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. schema: description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. examples: - 10 type: - integer - 'null' format: int32 minimum: 1 style: form example: 10 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MultiplePayoutsBody_for_Payout' example: payouts: - payout_id: fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA status: in_transit amount: 2500 arrival_date: string created_at: '2026-06-15T14:30:00Z' test_mode: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' example: detail: - loc: - string msg: string type: string '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string security: - BearerAuth: - payouts:read components: schemas: Timestamptz: description: >- A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). type: string example: string MultiplePayoutsBody_for_Payout: description: An envelope wrapping a list of payout objects. type: object required: - payouts properties: payouts: description: The list of payouts. type: array items: $ref: '#/components/schemas/Payout' example: payouts: - payout_id: fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA status: in_transit amount: 2500 arrival_date: string created_at: '2026-06-15T14:30:00Z' test_mode: false HttpErrorOut: title: HttpError description: The error response returned when a request cannot be completed. type: object required: - code - detail properties: code: description: A short machine-readable error code identifying the type of error. type: string detail: description: A human-readable explanation of what went wrong. type: string example: code: string detail: string HTTPValidationError: description: The error response returned when request validation fails (HTTP 422). type: object required: - detail properties: detail: description: The list of validation errors, one entry per invalid field. type: array items: $ref: '#/components/schemas/ValidationErrorItem' example: detail: - loc: - string msg: string type: string Payout: description: >- A Payout represents a transfer of funds from your Flex balance to your bank account. It aggregates the balance transactions that settle in a given payout and tracks the payout's status and arrival date. type: object required: - amount - arrival_date - created_at - payout_id - status - test_mode properties: payout_id: description: Unique identifier for the payout, prefixed with `fpo_`. type: string example: fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA status: $ref: '#/components/schemas/Status3' description: >- Status of the payout: `in_transit` (on its way to the bank), `paid` (deposited), `failed` (could not be completed), or `canceled`. amount: description: >- Amount paid out, in the smallest currency unit (e.g., `150000` = $1,500.00 USD). type: integer format: int32 example: 2500 arrival_date: $ref: '#/components/schemas/Timestamptz' description: >- When the payout is expected to arrive in your bank account. RFC 3339 timestamp. created_at: $ref: '#/components/schemas/Timestamptz' description: When the payout was created. RFC 3339 timestamp. example: '2026-06-15T14:30:00Z' source_type: description: >- The kind of balance the payout was drawn from (e.g., `card`, `bank_account`). type: - string - 'null' test_mode: description: >- Whether this payout was created in test mode. `true` for test-mode data, `false` for live data. type: boolean example: false balance_transaction: description: >- Balance transaction that describes the impact of this payout on your balance. Defaults to the balance transaction ID; always serialized, `null` for payouts without a linked balance transaction yet. anyOf: - $ref: '#/components/schemas/Expandable_for_BalanceTransaction' - type: 'null' failure_balance_transaction: description: >- Reversal balance transaction created when a payout fails and funds are credited back. Always serialized; `null` on the common success path. anyOf: - $ref: '#/components/schemas/Expandable_for_BalanceTransaction' - type: 'null' example: payout_id: fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA status: in_transit amount: 2500 arrival_date: string created_at: '2026-06-15T14:30:00Z' test_mode: false balance_transaction: fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA failure_balance_transaction: fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA ValidationErrorItem: description: >- Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error. type: object required: - loc - msg - type properties: loc: description: >- The location as a [`Vec`] of [`String`]s -- often in the form `["body", "field_name"]`, `["query", "field_name"]`, etc. They may, however, be arbitarily deep. type: array items: type: string msg: description: The message accompanying the validation error item. type: string type: description: >- The type of error, often "type_error" or "value_error", but sometimes with more context like as "value_error.number.not_ge" type: string example: loc: - string msg: string type: string Status3: type: string enum: - in_transit - paid - failed - canceled x-ms-enum: name: Status3 modelAsString: false values: - value: in_transit name: InTransit description: >- The payout has been initiated and is on its way to the bank account. - value: paid name: Paid description: The payout has been deposited into the bank account. - value: failed name: Failed description: The payout could not be completed. - value: canceled name: Canceled description: The payout was canceled before it completed. description: >- Status of a payout. - `in_transit`: The payout has been initiated and is on its way to the bank account. - `paid`: The payout has been deposited into the bank account. - `failed`: The payout could not be completed. - `canceled`: The payout was canceled before it completed. example: in_transit Expandable_for_BalanceTransaction: anyOf: - type: string example: fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA - $ref: '#/components/schemas/BalanceTransaction' example: fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA description: >- An expandable field — either a string ID or an expanded BalanceTransaction object. BalanceTransaction: description: >- A BalanceTransaction represents a single change to your Flex account balance — for example, a charge, refund, dispute, fee, or payout. Each transaction records how much was added or removed, the processing fee, and the resulting net effect on your balance, and links back to the Flex object that caused it. type: object required: - amount - balance_transaction_id - fee - net - status - test_mode properties: balance_transaction_id: description: >- Unique identifier for the balance transaction, prefixed with `fbtxn_`. type: string example: fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA amount: description: >- Gross amount of the transaction, in the smallest currency unit (e.g., `1000` = $10.00 USD). Positive for funds added to your balance (e.g., charges) and negative for funds removed (e.g., refunds, payouts, dispute debits). type: integer format: int32 example: 2500 available_on: description: >- When the funds become available in your bank account. RFC 3339 timestamp. anyOf: - $ref: '#/components/schemas/Timestamptz' - type: 'null' created_at: description: When the transaction was created. RFC 3339 timestamp. anyOf: - $ref: '#/components/schemas/Timestamptz' - type: 'null' example: '2026-06-15T14:30:00Z' exchange_rate: description: >- The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place. type: - number - 'null' format: double example: 1 fee: description: >- Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies. type: integer format: int32 example: 2500 net: description: >- Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD). type: integer format: int32 example: 2500 reporting_category: description: >- High-level accounting category for the transaction. `null` if not yet categorized. type: - string - 'null' example: example_value checkout_session_id: description: >- ID of the Checkout Session that originated this transaction, if it stems from a checkout. type: - string - 'null' example: fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA client_reference_id: description: >- Your own identifier for the originating object, carried over from the checkout session or payment. type: - string - 'null' example: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA status: $ref: '#/components/schemas/BalanceTransactionStatus' description: >- Availability status of the funds: `pending` (not yet available) or `available` (settled and withdrawable). source_id: description: >- ID of the Flex object that produced this transaction (e.g., a Charge `fch_`, Refund `fre_`, or Payout `fpo_`). `null` if the source has not been resolved to a Flex object. type: - string - 'null' example: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA type: description: The type of transaction. type: - string - 'null' flex_payment_intent_id: description: >- ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts). type: - string - 'null' example: fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA test_mode: description: >- Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data. type: boolean example: false mid: description: >- Merchant identifier (MID) for the account that processed the transaction. type: - string - 'null' example: example_value currency: description: Three-letter ISO currency code, in lowercase (e.g., `usd`). type: - string - 'null' example: usd metadata: description: >- Set of key-value pairs you can attach to the object for storing additional structured information. type: - object - 'null' additionalProperties: type: string example: order_id: '8842' channel: shopify transaction_fee_amount: description: >- Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out. type: - integer - 'null' format: int32 interchange_fee_amount: description: >- Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out. type: - integer - 'null' format: int32 lmn_fee_amount: description: >- Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable. type: - integer - 'null' format: int32 dispute_fee_amount: description: >- Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable. type: - integer - 'null' format: int32 card_type: description: Card funding type used for the transaction. type: - string - 'null' card_network: description: Card network used for the transaction (e.g., `visa`, `mastercard`). type: - string - 'null' example: balance_transaction_id: fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA amount: 2500 available_on: string created_at: '2026-06-15T14:30:00Z' exchange_rate: 1 fee: 2500 net: 2500 reporting_category: example_value checkout_session_id: fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA client_reference_id: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA status: available source_id: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA flex_payment_intent_id: fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA test_mode: false mid: example_value currency: usd metadata: order_id: '8842' channel: shopify BalanceTransactionStatus: type: string enum: - available - pending x-ms-enum: name: BalanceTransactionStatus modelAsString: false values: - value: available name: Available description: Funds have settled and are available to be paid out. - value: pending name: Pending description: Funds are not yet available. description: |- Availability status of the funds in a balance transaction. - `available`: Funds have settled and are available to be paid out. - `pending`: Funds are not yet available. example: available securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: Use a Bearer token to access this API. ````