Skip to main content
GET
List Payouts

Overview

Returns a paginated list of payout line items, showing what is owed, paid, and outstanding for each order item. Supports filtering by vendor, date range, payment status, and fulfillment status.

Use Cases

  • Generate payout reports for accounting or tax preparation
  • Reconcile payments by comparing paid vs. unpaid balances
  • Build a custom payout dashboard for merchant oversight
  • Automate payment triggers by monitoring unpaid items via API

Query Parameters

string
Filter by vendor ID.
string
Start date in YYYY-MM-DD format.
string
End date in YYYY-MM-DD format.
string
Payment status filter: "paid", "partial", or "unpaid".
string
Fulfillment status: "fulfilled" or "unfulfilled".
number
Results per page. Default: 100.
number
Number of results to skip. Default: 0.

Response

200

Example