Payout Summary
Payouts
Payout Summary
Get a high-level summary of payout totals and the next scheduled payout
GET
Payout Summary
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Return a high-level summary of the vendor’s payout totals, including the most recent payout, the next scheduled payout, and aggregate amounts. Useful for building a payouts dashboard.Use Cases
- Payouts dashboard — Show “Total received”, “Pending”, and “Next payout” cards
- Financial overview — Give vendors a snapshot of their earnings at a glance
- Payout scheduling visibility — Display when the next automated payout will run
Headers
string
required
A valid vendor JWT. Requires
payouts:read scope.Query Parameters
string
Filter by vendor ID (24-character hex string). Defaults to the authenticated vendor.
string
ISO 8601 lower bound on the date range.
string
ISO 8601 upper bound on the date range.
Response
200
Error Responses
401
403