> ## Documentation Index > Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt > Use this file to discover all available pages before exploring further. # List pending payouts > List each vendor's unpaid payout total for a date window. Requires the `admin:payouts` permission. ## OpenAPI ````yaml openapi-merchant.json GET /payouts/pending openapi: 3.0.0 info: title: PuppetVendors Merchant API V2 version: 2.0.0 description: >- The endpoints reachable with a merchant API key (`mk_live_…`), minted from Settings → API Access in the PuppetVendors admin. A merchant key administers users and vendors, and renews its own token. Everything else in the V2 API, including orders, products, payouts, fulfillments and documents, stays on the v1 API token and is refused here with a 403. Keys are revealed once at creation; rotating one leaves the previous key working for a 24 hour grace window. contact: name: PuppetVendors Support url: https://puppetvendors.com license: name: Proprietary servers: - url: https://production-api.puppetvendors.com description: Production - url: http://localhost:8082 description: Local development security: - bearerAuth: [] tags: - name: Auth description: Authentication endpoints for obtaining and refreshing API tokens - name: Portal - Auth description: Vendor portal authentication endpoints (vendor user login, token refresh) - name: Products description: Product management and synchronization - name: Orders description: Order retrieval and management - name: Payouts description: Vendor payout information - name: Fulfillments description: Order fulfillment operations - name: Reports description: Vendor sales reports and analytics - name: Vendors description: Vendor management operations - name: Settings description: Settings endpoints for vendor configuration and management - name: Users description: User account management - name: Shop description: Shop configuration and settings - name: Commissions description: Commission rate management - name: Integrations description: Vendor integration configuration endpoints - name: Line Items description: Order line item operations paths: /payouts/pending: get: tags: - Payouts summary: List pending payouts description: >- List each vendor's unpaid payout total for a date window. Requires the `admin:payouts` permission. operationId: listPendingPayoutSummaries parameters: - in: query name: startDate schema: type: string description: >- Window start, YYYY-MM-DD (shop timezone) or full ISO. Defaults to the first day of the current month in the shop timezone. example: '2026-03-01' - in: query name: endDate schema: type: string description: >- Window end, YYYY-MM-DD (shop timezone) or full ISO. Defaults to now; a future date is clamped to now. example: '2026-03-31' - in: query name: vendorId schema: type: string description: Narrows the summary to a single vendor example: 507f1f77bcf86cd799439012 - in: query name: first schema: type: integer minimum: 1 maximum: 100 description: Number of vendors to return (sorted amount desc) - in: query name: after schema: type: string description: Cursor for forward pagination (from a previous page endCursor) - in: query name: last schema: type: integer minimum: 1 maximum: 100 description: Number of vendors to return (backward pagination) - in: query name: before schema: type: string description: Cursor for backward pagination (from a previous page startCursor) responses: '200': description: Vendor pending summaries in the standard cursor envelope content: application/json: schema: type: object properties: success: type: boolean data: type: object properties: edges: type: array items: type: object properties: node: type: object properties: vendorName: type: string vendorId: type: string amount: type: number description: >- Pending payout (line items + unpaid adjustments) currency: type: string nullable: true fromDate: type: string format: date-time nullable: true toDate: type: string format: date-time nullable: true payoutMethod: type: string enum: - stripe - paypal - globalPayouts - manual description: > The method a payout run would use for this vendor right now, worked out per request: stripe, then paypal, then globalPayouts, else manual. `paypal` means the shop has PayPal switched on and the vendor has a PayPal email. It does not check the shop's PayPal connection; GET /payouts/methods does. Not the vocabulary of GET /payouts/transactions, where `paypal` means a payment logged as made outside the app. itemsCount: type: number cursor: type: string pageInfo: type: object '400': description: >- Invalid filters, or a range longer than 12 months (DATE_RANGE_EXCEEDED) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Forbidden - merchant scope with admin:payouts required, or MERCHANT_PAYOUTS_API_NOT_ENABLED (the payouts API is not enabled for this store) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ErrorResponse: type: object required: - success - error properties: success: type: boolean enum: - false description: Indicates the request failed error: type: object required: - message properties: message: type: string description: Human-readable error message example: Resource not found code: type: string description: >- Stable machine-readable error code. The frontend uses this as its localisation key (e.g. errors.api.). Server errors always report INTERNAL_SERVER_ERROR. example: NOT_FOUND errorId: type: string description: >- Correlation id for support/log lookup. Present on opaque 5xx responses so a user can quote a reference for the underlying (server-side logged) error. example: err_1783365360839_j281w7b details: type: object description: >- Additional client-error context (e.g. field-level validation errors). Never populated for server errors. securitySchemes: bearerAuth: type: apiKey in: header name: x-access-token description: >- JWT minted from a merchant API key (`mk_live_…`) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.