> ## Documentation Index
> Fetch the complete documentation index at: https://partner-docs.tickify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Stripe payment statistics for authenticated partner

> 
Returns financial statistics for the authenticated partner's connected Stripe account.

**Authentication:** Requires valid Partner API Key in Authorization header (Bearer token).

**Metrics returned:**
- `grossVolume`: Total successful charges (in currency units, e.g., USD)
- `pendingPayout`: Funds pending transfer to partner's bank
- `withdrawn`: Available balance ready for payout
- `platformFeesCollected`: Total application fees collected by Tickify (platform revenue)

**Optional filtering:**
- `eventKey`: Filter stats for a specific event (passed as `transfer_group` in metadata)

**Requirements:**
- Partner must have completed Stripe onboarding (`stripeOnboardVerified: true`)
- Returns zeros if no Stripe account connected
    



## OpenAPI

````yaml /partner-docs/openapi.json get /partners/stripe-connect/stats
openapi: 3.0.0
info:
  title: Tickify Partner API
  description: >2-

        API documentation for the Tickify Partner Platform.

        Getting Started:
    1. Register as a partner and wait for approval from the Tickify team.
        2. Once approved, request an API key from the Tickify team. A Tickify admin will generate and securely share your API key with you.
        3. Use your API key to authenticate partner API requests.
        4. Generate an access token using the /partner/auth/token endpoint in the Auth documentation.
        5. Use the access token for authenticated requests where required.

        **API Keys:**
    - Test keys use the 

    `tk_test_` prefix. These keys work in sandbox mode and never charge real
    payment methods.

    - Live keys use the 

    `tk_live_` prefix. These keys process real payments and require completed
    Stripe Connect onboarding.

    - Both key types follow the same API behavior — only the payment environment
    differs.

    - To test checkout flows without real charges, use 

    `tk_test_` keys and include test card numbers in your Stripe integration.
        
  version: '1.0'
  contact: {}
servers:
  - url: http://localhost:3000
    description: Local Development
  - url: https://api-staging.tickify.io
    description: Staging
  - url: https://api.tickify.io
    description: Production
security: []
tags: []
paths:
  /partners/stripe-connect/stats:
    get:
      tags:
        - Partners
      summary: Get Stripe payment statistics for authenticated partner
      description: >-

        Returns financial statistics for the authenticated partner's connected
        Stripe account.


        **Authentication:** Requires valid Partner API Key in Authorization
        header (Bearer token).


        **Metrics returned:**

        - `grossVolume`: Total successful charges (in currency units, e.g., USD)

        - `pendingPayout`: Funds pending transfer to partner's bank

        - `withdrawn`: Available balance ready for payout

        - `platformFeesCollected`: Total application fees collected by Tickify
        (platform revenue)


        **Optional filtering:**

        - `eventKey`: Filter stats for a specific event (passed as
        `transfer_group` in metadata)


        **Requirements:**

        - Partner must have completed Stripe onboarding (`stripeOnboardVerified:
        true`)

        - Returns zeros if no Stripe account connected
            
      operationId: PartnersController_getPartnerStripeStats
      parameters:
        - name: eventKey
          required: false
          in: query
          description: Filter stats by event key (transfer_group)
          schema:
            example: evt_xyz789
            type: string
      responses:
        '200':
          description: Payment statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  grossVolume:
                    type: number
                    example: 12500.5
                  pendingPayout:
                    type: number
                    example: 3200
                  withdrawn:
                    type: number
                    example: 9300.5
                  platformFeesCollected:
                    type: number
                    example: 625
        '401':
          description: Invalid or missing partner API key
        '404':
          description: Partner not found
        '422':
          description: Validation failed or partner not found
      security:
        - access-token: []
        - partner-api-key: []
components:
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http
    partner-api-key:
      type: apiKey
      in: header
      name: x-partner-key
      description: Partner API Key (tk_live_... or tk_test_...)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.