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

# List Payments

Retrieve all payments across marketplace connections with filtering by date range, payment type, status, and provider status. Each payment includes amounts, fees, and timestamps.

Supports pagination via `page` and `page_size` query parameters.


## OpenAPI

````yaml openapi/marketplace-earnings.yaml post /partners/payments
openapi: 3.0.3
info:
  title: Everflow Marketplace API - Earnings
  description: >
    Marketplace earnings and payment endpoints for the Everflow partner
    marketing platform. Retrieve payment history across all marketplace
    connections. For more detail, see [The Marketplace Earnings
    Report](https://helpdesk.everflow.io/collaborator/the-marketplace-earnings-report)
    in the Help Center.
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
security: []
tags:
  - name: Marketplace Earnings
    description: Endpoints for retrieving marketplace payment data.
paths:
  /partners/payments:
    post:
      tags:
        - Marketplace Earnings
      summary: Find All Payments
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number (1-based).
        - in: query
          name: page_size
          schema:
            type: integer
            default: 50
          description: Number of results per page.
      requestBody:
        required: true
        content:
          application/json:
            example:
              timezone_id: 80
              from: '2025-10-22'
              to: '2025-11-21'
              query:
                search_terms: []
                filter:
                  partner_connection_ids: []
                  payment_types:
                    - pay
                  network_ids:
                    - 15
                  payment_provider_payment_status: paid
            schema:
              type: object
              required:
                - timezone_id
              properties:
                timezone_id:
                  type: integer
                  description: Timezone identifier for the request.
                from:
                  type: string
                  description: >
                    Start date for filtering payments (format: "yyyy-MM-dd"). 
                    Optional if any date filter is provided in the `filter`
                    object.
                to:
                  type: string
                  description: >
                    End date for filtering payments (format: "yyyy-MM-dd"). 
                    Optional if any date filter is provided in the `filter`
                    object.
                query:
                  type: object
                  description: Query configuration for additional filtering.
                  properties:
                    search_terms:
                      type: array
                      description: Terms used to filter the data.
                      items:
                        type: object
                        required:
                          - search_type
                          - value
                        properties:
                          search_type:
                            type: string
                            enum:
                              - network_name
                            description: Type of the terms of the search.
                          value:
                            type: string
                            description: Value of the term to filter by.
                    filter:
                      type: object
                      description: Structured filters to narrow payment results.
                      properties:
                        partner_connection_ids:
                          type: array
                          description: Filter by specific partner connection IDs.
                          items:
                            type: integer
                        payment_types:
                          type: array
                          description: Filter by payment type.
                          items:
                            type: string
                            enum:
                              - pay
                              - veem
                              - tipalti
                        network_ids:
                          type: array
                          description: Filter by network IDs.
                          items:
                            type: integer
                        payment_status:
                          type: string
                          enum:
                            - pending
                            - rejected
                            - success
                            - scheduled
                          description: Affiliate payment status to filter by.
                        payment_provider_payment_status:
                          type: string
                          enum:
                            - unpaid
                            - in_progress
                            - paid
                            - rejected
                          description: Payment provider status to filter by.
                        time_created_from:
                          type: string
                          description: >
                            Start date for filtering by creation time (format:
                            "yyyy-MM-dd").
                        time_created_to:
                          type: string
                          description: >
                            End date for filtering by creation time (format:
                            "yyyy-MM-dd").
                        time_approved_from:
                          type: string
                          description: >
                            Start date for filtering by approval time (format:
                            "yyyy-MM-dd").
                        time_approved_to:
                          type: string
                          description: >
                            End date for filtering by approval time (format:
                            "yyyy-MM-dd").
                        time_completed_from:
                          type: string
                          description: >
                            Start date for filtering by completion time (format:
                            "yyyy-MM-dd").
                        time_completed_to:
                          type: string
                          description: >
                            End date for filtering by completion time (format:
                            "yyyy-MM-dd").
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  payments:
                    type: array
                    description: Array of payment objects.
                    items:
                      type: object
                      properties:
                        partner_payment_id:
                          type: integer
                          description: Unique payment ID.
                        partner_id:
                          type: integer
                          description: Partner ID that received the payment.
                        network_id:
                          type: integer
                          description: Network ID that issued the payment.
                        partner_connection_id:
                          type: integer
                          description: Connection ID linking the partner and network.
                        payment_type:
                          type: string
                          enum:
                            - pay
                            - veem
                            - tipalti
                          description: Payment method type.
                        payment_status:
                          type: string
                          enum:
                            - pending
                            - rejected
                            - success
                            - scheduled
                          description: Current status of the payment.
                        payment_provider_payment_status:
                          type: string
                          enum:
                            - unpaid
                            - in_progress
                            - paid
                            - rejected
                          description: Status from the payment provider's side.
                        time_invoice_approved:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of when the invoice was approved.
                        time_payment_approved:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of when the payment was approved.
                        time_payment_completed:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of when the payment was completed.
                        amount:
                          type: number
                          description: Total payment amount.
                        currency:
                          type: string
                          description: Currency code for the payment (e.g. "USD").
                        network_name:
                          type: string
                          description: Name of the network.
                        payee_original_amount:
                          type: number
                          description: Original amount for the payee.
                        payee_fee_amount:
                          type: number
                          description: Fee amount for the payee.
                        payee_paid_amount:
                          type: number
                          description: Amount paid to the payee.
                        payee_currency:
                          type: string
                          description: Currency code for the payee.
                        network_affiliate_payment_id:
                          type: integer
                          description: Network's affiliate payment ID.
                        network_affiliate_invoice_id:
                          type: integer
                          description: Network's affiliate invoice ID.
                        time_created:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of when the payment was created.
                        time_approved:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of when the payment was approved.
                        time_completed:
                          type: integer
                          example: 1734455015
                          description: Unix timestamp of when the payment was completed.
                  paging:
                    type: object
                    properties:
                      page:
                        type: integer
                        description: Current page number.
                      page_size:
                        type: integer
                        description: Number of results per page.
                      total_count:
                        type: integer
                        description: Total number of matching payments.
      security:
        - API Key: []
components:
  securitySchemes:
    API Key:
      description: >
        The marketplace partner's API key. Uses the X-Eflow-Api-Key header. The
        key belongs to the marketplace partner user.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````