THthredfi
Payouts

List payouts

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

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)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Business UUID (unique identifier for the business)

Query parameters

completed_at_endstring date-time

Filter payouts completed to this date/time

completed_at_startstring date-time

Filter payouts completed from this date/time

external_idstring

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

max_amountinteger

Maximum payout amount in cents

min_amountinteger

Minimum payout amount in cents

pageinteger

Page number (1-indexed, default: 1)

page_sizeinteger

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

processorstring

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

reconciliation_statusstring

Filter by reconciliation status (unreconciled, partially_reconciled, fully_reconciled)

searchstring

Search by external_id, reference_number, memo, or processor_payout_id

statusstring

Filter by payout status

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.