--- title: "List Payouts" method: GET path: "/v1/payouts" tags: ["Payouts"] --- # List Payouts `GET /v1/payouts` Returns a list of payouts. ## Query parameters - `payout_id` string, nullable — Filter by a specific payout ID. - `start_date` string — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `end_date` string — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `limit` integer, nullable — A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. ## Response `200` An envelope wrapping a list of payout objects. - MultiplePayoutsBodyForPayout — An envelope wrapping a list of payout objects. - `payouts` Payout[], required — The list of payouts. - `payout_id` string, required — Unique identifier for the payout, prefixed with `fpo_`. - `status` 'in_transit' | 'paid' | 'failed' | 'canceled', required — 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. - `amount` integer, required — Amount paid out, in the smallest currency unit (e.g., `150000` = $1,500.00 USD). - `arrival_date` string, required — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `created_at` string, required — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `source_type` string, nullable — The kind of balance the payout was drawn from (e.g., `card`, `bank_account`). - `test_mode` boolean, required — Whether this payout was created in test mode. `true` for test-mode data, `false` for live data. - `balance_transaction` union — An expandable field — either a string ID or an expanded BalanceTransaction object. - string - BalanceTransaction — 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. - `balance_transaction_id` string, required — Unique identifier for the balance transaction, prefixed with `fbtxn_`. - `amount` integer, required — 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). - `available_on` string — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `created_at` string — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `exchange_rate` number, double, nullable — The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place. - `fee` integer, required — Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies. - `net` integer, required — Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD). - `reporting_category` string, nullable — High-level accounting category for the transaction. `null` if not yet categorized. - `checkout_session_id` string, nullable — ID of the Checkout Session that originated this transaction, if it stems from a checkout. - `client_reference_id` string, nullable — Your own identifier for the originating object, carried over from the checkout session or payment. - `status` 'available' | 'pending', required — 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. - `source_id` string, nullable — 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, nullable — The type of transaction. - `flex_payment_intent_id` string, nullable — ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts). - `test_mode` boolean, required — Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data. - `mid` string, nullable — Merchant identifier (MID) for the account that processed the transaction. - `currency` string, nullable — Three-letter ISO currency code, in lowercase (e.g., `usd`). - `metadata` object, nullable — Set of key-value pairs you can attach to the object for storing additional structured information. - `transaction_fee_amount` integer, nullable — Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out. - `interchange_fee_amount` integer, nullable — Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out. - `lmn_fee_amount` integer, nullable — Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable. - `dispute_fee_amount` integer, nullable — Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable. - `card_type` string, nullable — Card funding type used for the transaction. - `card_network` string, nullable — Card network used for the transaction (e.g., `visa`, `mastercard`). - `failure_balance_transaction` union — An expandable field — either a string ID or an expanded BalanceTransaction object. - string - BalanceTransaction — 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. - `balance_transaction_id` string, required — Unique identifier for the balance transaction, prefixed with `fbtxn_`. - `amount` integer, required — 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). - `available_on` string — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `created_at` string — A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). - `exchange_rate` number, double, nullable — The exchange rate applied if the transaction involved a currency conversion. `null` when no conversion took place. - `fee` integer, required — Total processing fee deducted from `amount`, in the smallest currency unit (e.g., `30` = $0.30 USD). `0` when no fee applies. - `net` integer, required — Net amount that affects your balance after `fee` is applied (`net = amount - fee`), in the smallest currency unit (e.g., `970` = $9.70 USD). - `reporting_category` string, nullable — High-level accounting category for the transaction. `null` if not yet categorized. - `checkout_session_id` string, nullable — ID of the Checkout Session that originated this transaction, if it stems from a checkout. - `client_reference_id` string, nullable — Your own identifier for the originating object, carried over from the checkout session or payment. - `status` 'available' | 'pending', required — 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. - `source_id` string, nullable — 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, nullable — The type of transaction. - `flex_payment_intent_id` string, nullable — ID of the Payment Intent associated with this transaction, if any. `null` for transactions not tied to a payment (e.g., payouts). - `test_mode` boolean, required — Whether this transaction was created in test mode. `true` for test-mode data, `false` for live data. - `mid` string, nullable — Merchant identifier (MID) for the account that processed the transaction. - `currency` string, nullable — Three-letter ISO currency code, in lowercase (e.g., `usd`). - `metadata` object, nullable — Set of key-value pairs you can attach to the object for storing additional structured information. - `transaction_fee_amount` integer, nullable — Portion of `fee` attributable to standard transaction processing, in the smallest currency unit. `null` if not broken out. - `interchange_fee_amount` integer, nullable — Portion of `fee` attributable to card-network interchange, in the smallest currency unit. `null` if not broken out. - `lmn_fee_amount` integer, nullable — Portion of `fee` attributable to Letter of Medical Necessity (LMN) processing, in the smallest currency unit. `null` if not applicable. - `dispute_fee_amount` integer, nullable — Portion of `fee` attributable to a dispute, in the smallest currency unit. `null` if not applicable. - `card_type` string, nullable — Card funding type used for the transaction. - `card_network` string, nullable — Card network used for the transaction (e.g., `visa`, `mastercard`). ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `409` — Conflict - `422` — Validation Error - `429` — Too Many Requests --- [API](https://skmtc.dev/withflex/apis/flex-api.md) · [All operations](https://skmtc.dev/withflex/apis/flex-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withflex/flex-api/revisions/b1560fc2f199/schema)