List Payout Transactions
Payouts
List Payout Transactions
List payout transactions with cursor pagination and filters
GET
List Payout Transactions
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Return a paginated list of payout transactions for the authenticated vendor. Uses cursor-based pagination for stable results when data changes between pages.Use Cases
- Payout history table — Show a list of past payouts with status and amounts
- Transaction lookup — Search for a specific payout by transaction ID or date
- Reconciliation — Cross-reference payouts with bank deposits
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
Filter by status:
pending · paid · failed · cancelled.string
ISO 8601 lower bound on transaction date.
string
ISO 8601 upper bound on transaction date.
string
Free-text search (max 200 characters). Searches transaction IDs and order references.
integer
Number of records to return from the start of the result set (forward pagination).
string
Cursor for forward pagination. Use the
endCursor value from a previous response.integer
Number of records to return from the end of the result set (backward pagination).
string
Cursor for backward pagination. Use the
startCursor value from a previous response.Response
200
Error Responses
401
403