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

# Find Payment Transactions

> Search payment transactions with given parameters.



## OpenAPI

````yaml https://api.getmeasure.com/api/v1/docs/api_spec.json post /companies/{company_id}/payments/transactions/find
openapi: 3.1.0
info:
  title: Measure API
  description: APIs to communicate with Measure
  version: 1.0.0
servers:
  - url: https://api.getmeasure.com/api/v1
security: []
paths:
  /companies/{company_id}/payments/transactions/find:
    post:
      tags:
        - Payments
      summary: Find Payment Transactions
      description: Search payment transactions with given parameters.
      operationId: Find_Payment_Transactions
      parameters:
        - name: company_id
          in: path
          description: 'The company ID with the prefix ''cmp_''. '
          required: true
          schema:
            description: 'The company ID with the prefix ''cmp_''. '
            type: string
        - name: Idempotency-Key
          in: header
          description: >-
            The idempotency key that will be used to ensure the request is only
            performed once
          schema:
            description: >-
              The idempotency key that will be used to ensure the request is
              only performed once
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestFindPaymentTransactionsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFindPaymentTransactionsResponse'
      deprecated: false
      security:
        - apiKey:
            - ''
components:
  schemas:
    RequestFindPaymentTransactionsRequest:
      properties:
        include_meta:
          description: >-
            Whether to include additional metadata in the pagination response
            such the number of total results
          type:
            - boolean
            - 'null'
        pagination:
          $ref: '#/components/schemas/RequestPaginationRequest'
          description: The pagination parameters for the request
        query:
          $ref: '#/components/schemas/RequestFindPaymentTransactionsQueryCriteria'
          description: The query criteria for the request
        sort_key:
          default: createdAtDesc
          enum:
            - createdAtDesc
            - createdAtAsc
            - updatedAtAsc
            - updatedAtDesc
            - totalAmountAsc
            - totalAmountDesc
          type:
            - 'null'
            - string
      required:
        - pagination
      type: object
    ResponseFindPaymentTransactionsResponse:
      properties:
        pagination:
          $ref: '#/components/schemas/ResponsePaginationResponse'
        results:
          items:
            $ref: '#/components/schemas/ResponsePaymentTransactionRepresentation'
          type:
            - array
            - 'null'
      type: object
    RequestPaginationRequest:
      description: The pagination parameters for the request
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          default: 20
          format: int64
          maximum: 200
          minimum: 0
          type: integer
      type: object
    RequestFindPaymentTransactionsQueryCriteria:
      properties:
        currency:
          description: The currency of the payment transaction
          type:
            - 'null'
            - string
        customer_id:
          description: The customer the payment was for
          type:
            - 'null'
            - string
        invoice_number:
          description: >-
            The invoice number which this payment transaction was associated
            with
          type:
            - 'null'
            - string
        invoice_uuid:
          description: >-
            The UUID of the invoice which this payment transaction was
            associated with
          type:
            - 'null'
            - string
        provider_transaction_ids:
          description: Filter based on transaction IDs given by payment provider
          items:
            type: string
          type:
            - 'null'
            - array
        provider_type:
          description: >-
            The payment provider through which this payment or refund was
            processed
          type:
            - 'null'
            - string
        search:
          description: Any search string to match payment transactions
          type:
            - 'null'
            - string
        show_connected_account:
          description: Whether this payment transaction was through a connected account
          type:
            - 'null'
            - boolean
        status:
          description: >-
            The specific status of the payment transaction can be one of
            SUCCESS, FAILED, PARTIAL_REFUNDED, REFUNDED, CANCELLED or PROCESSING
          type:
            - 'null'
            - string
        total_amount:
          $ref: '#/components/schemas/ModelAmountFilter'
          description: Filter based on total amount ranges
        transaction_type:
          description: The payment transaction type that can be one of PAYMENT or REFUND
          type:
            - 'null'
            - string
      type: object
    ResponsePaginationResponse:
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          format: int64
          type: integer
      type: object
    ResponsePaymentTransactionRepresentation:
      properties:
        application_fee_amount:
          $ref: '#/components/schemas/ModelAmount'
        company_id:
          type: string
        connected_account_transaction:
          type: boolean
        created_at:
          format: date-time
          type: string
        customer:
          $ref: '#/components/schemas/ResponseEmbeddedCustomerRepresentation'
        customer_id:
          type: string
        deleted_at:
          format: date-time
          type:
            - 'null'
            - string
        disallow_partial_refund:
          type:
            - 'null'
            - boolean
        id:
          type: string
        initiated_by:
          type:
            - 'null'
            - string
        initiated_by_type:
          type:
            - 'null'
            - string
        invoice_number:
          type: string
        invoice_uuid:
          type: string
        is_refundable:
          type: boolean
        is_voidable:
          type: boolean
        net_amount:
          $ref: '#/components/schemas/ModelAmount'
        note:
          type:
            - 'null'
            - string
        payment_method:
          $ref: '#/components/schemas/ResponsePaymentMethodData'
        proposal_id:
          type:
            - 'null'
            - string
        provider_transaction_id:
          type: string
        provider_type:
          type: string
        refundable_amount:
          $ref: '#/components/schemas/ModelAmount'
        status:
          type: string
        status_message:
          type:
            - 'null'
            - string
        stripe_fee_amount:
          $ref: '#/components/schemas/ModelAmount'
        total_amount:
          $ref: '#/components/schemas/ModelAmount'
        total_amount_default_currency:
          $ref: '#/components/schemas/ModelAmount'
        total_fee_amount:
          $ref: '#/components/schemas/ModelAmount'
        transaction_type:
          type: string
        updated_at:
          format: date-time
          type: string
      type: object
    ModelAmountFilter:
      properties:
        eq:
          description: Equal to
          type:
            - 'null'
            - number
        gt:
          description: Greater than
          type:
            - 'null'
            - number
        gte:
          description: Greater than or equal to
          type:
            - 'null'
            - number
        lte:
          description: Less than or equal to
          type:
            - 'null'
            - number
      type:
        - object
        - 'null'
    ModelAmount:
      description: The amount which has value in cents and a currency
      properties:
        currency:
          type: string
        value_in_cents:
          format: int64
          type: integer
      type: object
    ResponseEmbeddedCustomerRepresentation:
      properties:
        email:
          type: string
        id:
          type: string
        identifier:
          type: string
        name:
          type: string
        org_name:
          type: string
        parent_customer:
          $ref: '#/components/schemas/ResponseEmbeddedCustomerRepresentation'
        parent_customer_id:
          type:
            - 'null'
            - string
      type: object
    ResponsePaymentMethodData:
      properties:
        brand:
          type: string
        last_4:
          type: string
        name:
          type: string
        type:
          type: string
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````