Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
payouts
List payouts
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/payouts/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "processor": "stripe",
      "processor_payout_id": "<string>",
      "paid_out_amount_cents": 0,
      "net_amount_cents": 123,
      "imported_at": "2023-11-07T05:31:56Z",
      "payment_count": 123,
      "refund_payment_count": 123,
      "gross_payments_amount_cents": 123,
      "total_refunds_amount_cents": 123,
      "expected_net_amount_cents": 123,
      "amount_variance_cents": 123,
      "reconciliation_status": "unreconciled",
      "settlement_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "fee_cents": 4611686018427388000,
      "additional_refunds_amount_cents": 4611686018427388000,
      "currency": "EUR",
      "status": "pending",
      "completed_at": "2023-11-07T05:31:56Z",
      "reference_number": "<string>",
      "memo": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

​
business_id
string<uuid>
required

Business UUID (unique identifier for the business)

Query Parameters

​
completed_at_end
string<date-time>

Filter payouts completed to this date/time

​
completed_at_start
string<date-time>

Filter payouts completed from this date/time

​
external_id
string

Filter by external ID (partial match, case-insensitive)

​
max_amount
integer

Maximum payout amount in cents

​
min_amount
integer

Minimum payout amount in cents

​
page
integer

Page number (1-indexed, default: 1)

​
page_size
integer

Number of items per page (default: 20, max: 100)

​
processor
string

Filter by payment processor (stripe, adyen, paypal, etc.)

​
reconciliation_status
string

Filter by reconciliation status (unreconciled, partially_reconciled, fully_reconciled)

​
search
string

Search by external_id, reference_number, memo, or processor_payout_id

​
status
string

Filter by payout status

Response

​
count
integer
required

Total number of items

Example:

123

​
page_info
object
required
Example:
{
  "total_count": 123,
  "current_page": 1,
  "total_pages": 7,
  "page_size": 20
}
​
results
object[]
required