Skip to main content
GET
List Payouts
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Retrieve a paginated list of payout transactions for the authenticated vendor. Results include transaction status, amounts, processing dates, and item counts. Only payouts belonging to the vendor are returned.
Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.

Use Cases

  • Payout dashboard — Display pending and completed payouts in a vendor portal
  • Accounting reconciliation — Export payout data for bookkeeping
  • Payment tracking — Monitor payout statuses and amounts

Query Parameters

string
Filter by payout status. One of: pending, paid, failed, cancelled.
string
Filter by date (minimum, ISO 8601). Example: 2024-01-01T00:00:00Z.
string
Filter by date (maximum, ISO 8601).
integer
Number of items to return, forward pagination (1-100).
string
Cursor for forward pagination.
integer
Number of items to return, backward pagination (1-100).
string
Cursor for backward pagination.

Response

200

Example

More Examples

Filter unpaid payouts
Payouts in date range