---
title: "List payouts"
method: GET
path: "/v1/platform/businesses/{business_id}/payouts/"
tags: ["Payouts"]
---

# List payouts

`GET /v1/platform/businesses/{business_id}/payouts/`

## Request

- Base URL: `https://docs.thredfi.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.thredfi.com/v1/platform/businesses/{business_id}/payouts/`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP basic
  - HTTP bearer
  - HTTP bearer

List all payouts within a business. Supports filtering by processor, status, date range, and search capabilities. Returns paginated results with standardized pagination.

## Path parameters

- `business_id` string, uuid, required

## Query parameters

- `completed_at_end` string, date-time
- `completed_at_start` string, date-time
- `external_id` string
- `max_amount` integer
- `min_amount` integer
- `page` integer
- `page_size` integer
- `processor` string
- `reconciliation_status` string
- `search` string
- `status` string

## Response `200`

- PaginatedPayoutListList
  - `count` integer, required: Total number of items
  - `page_info` object, required
    - `total_count` integer, required: Total number of items (same as count)
    - `current_page` integer, required: Current page number (1-indexed)
    - `total_pages` integer, required: Total number of pages
    - `page_size` integer, required: Number of items per page
  - `results` PayoutList[], required
    - `id` string, uuid, required
    - `business_id` string, uuid, required
    - `external_id` string
    - `processor` 'stripe' | 'paypal' | 'square' | 'adyen' | 'worldpay' | 'sage_pay' | 'klarna' | 'other' | '', required: * `stripe` - Stripe * `paypal` - PayPal * `square` - Square * `adyen` - Adyen * `worldpay` - Worldpay * `sage_pay` - Sage Pay * `klarna` - Klarna * `other` - Other
    - `processor_payout_id` string, required
    - `paid_out_amount_cents` integer, required: Net payout amount in cents (can be negative)
    - `fee_cents` integer
    - `additional_refunds_amount_cents` integer: Additional refunds not tied to specific RefundPayment records
    - `net_amount_cents` integer, required: Net amount: paid_out_amount - fee
    - `currency` 'EUR' | 'GBP' | 'USD' | 'SEK' | 'NOK' | 'DKK' | 'ISK' | 'MYR' | 'SGD': * `EUR` - Euro * `GBP` - British Pound * `USD` - US Dollar * `SEK` - Swedish Krona * `NOK` - Norwegian Krone * `DKK` - Danish Krone * `ISK` - Icelandic Króna * `MYR` - Malaysian Ringgit * `SGD` - Singapore Dollar
    - `status` 'pending' | 'processing' | 'paid' | 'failed' | 'cancelled': * `pending` - Pending * `processing` - Processing * `paid` - Paid * `failed` - Failed * `cancelled` - Cancelled
    - `completed_at` string, date-time, nullable
    - `imported_at` string, date-time, required
    - `reference_number` string
    - `memo` string
    - `payment_count` integer, required: Number of payments in this payout
    - `refund_payment_count` integer, required: Number of refund payments in this payout
    - `gross_payments_amount_cents` integer, required: Total amount of invoice payments before refunds
    - `total_refunds_amount_cents` integer, required: Total amount of refund payments in cents
    - `expected_net_amount_cents` integer, required: Expected net: payments - refunds - additional_refunds - fees
    - `amount_variance_cents` integer, required: Difference between reported and expected net
    - `reconciliation_status` 'unreconciled' | 'partially_reconciled' | 'fully_reconciled', required: Reconciliation state * `unreconciled` - Unreconciled * `partially_reconciled` - Partially Reconciled * `fully_reconciled` - Fully Reconciled
    - `settlement_file_id` string, uuid, nullable, required: Settlement file UUID if attached
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: Validation errors in request data
- `401`: Authentication required - missing or invalid API key
- `403`: Permission denied - insufficient privileges
- `404`: Resource not found
- `409`: Conflict - resource already exists or invalid state transition
- `422`: Unprocessable entity - business logic validation failed
- `500`: Internal server error

---

[API](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api.md) - [All operations](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/revisions/0c1918254db3?raw)