> ## 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 payout methods > List your vendors with the payout methods each one can currently be paid with (Stripe, PayPal, Global Payouts, or manual). A method is available only when the vendor is set up for it and the shop has it enabled and connected. Requires the `admin:payouts` permission. ## OpenAPI ````yaml openapi-merchant.json GET /payouts/methods 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/methods: get: tags: - Payouts summary: List payout methods description: >- List your vendors with the payout methods each one can currently be paid with (Stripe, PayPal, Global Payouts, or manual). A method is available only when the vendor is set up for it and the shop has it enabled and connected. Requires the `admin:payouts` permission. operationId: listPayoutMethods parameters: - in: query name: method schema: type: string enum: - stripe - paypal - globalPayouts - manual description: Keep only the vendors that can be paid with this method - in: query name: vendorId schema: type: string description: >- Narrow the list to this vendor. Must be a vendor of this shop; otherwise 404. example: 507f1f77bcf86cd799439012 - in: query name: first schema: type: integer minimum: 1 maximum: 100 description: Number of items to return (forward pagination) - 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 items to return (backward pagination) - in: query name: before schema: type: string description: Cursor for backward pagination (from a previous page startCursor) responses: '200': description: Vendors with their payout methods content: application/json: schema: $ref: '#/components/schemas/PayoutMethodsResponse' '400': description: Invalid query parameters 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' '404': description: Vendor not found (only when vendorId is supplied) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: PayoutMethodsResponse: type: object required: - success - data properties: success: type: boolean enum: - true data: type: object required: - edges - pageInfo properties: edges: type: array description: >- One edge per visible vendor, ordered by vendorName. Hidden vendors are left out. items: type: object required: - node - cursor properties: node: $ref: '#/components/schemas/PayoutMethodVendorNode' cursor: type: string description: >- Opaque cursor (vendorName + id); pass back as after/before. pageInfo: $ref: '#/components/schemas/PageInfo' 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. PayoutMethodVendorNode: type: object required: - vendorId - vendorName - methods properties: vendorId: type: string example: 507f1f77bcf86cd799439012 vendorName: type: string nullable: true example: Acme Goods methods: type: array description: >- One single-key object per method, in fixed order: stripe, paypal, globalPayouts, manual. The value says whether this vendor can be paid with that method: the vendor is set up on it AND the shop has it switched on and connected (the same checks make-payment runs). `manual` is always true. These are the READ-side method names; the execute body keeps legacy resolver keys (stripeConnected, paypalConnected, globalPayoutConnected, other). items: type: object minProperties: 1 maxProperties: 1 properties: stripe: type: boolean paypal: type: boolean globalPayouts: type: boolean manual: type: boolean enum: - true example: - stripe: true - paypal: false - globalPayouts: false - manual: true PageInfo: type: object required: - hasNextPage - hasPreviousPage properties: hasNextPage: type: boolean description: Whether there are more items after the current page hasPreviousPage: type: boolean description: Whether there are more items before the current page startCursor: type: string description: Cursor for the first item in the page nullable: true endCursor: type: string description: Cursor for the last item in the page nullable: true totalCount: type: integer description: Total number of items (may not always be available) nullable: true 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.