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

# Get an inspection's payments

> The invoice, what each payer owes, every payment with its Stripe id and whether it has settled, every refund, and bank payments the bank rejected. Read-only. Amounts are in the account's currency.

> [!NOTE]
>
> **The Hive Inspect API is a work in progress.** It is available to a small group of accounts today, and the release for everyone is coming very soon.


## OpenAPI

````yaml /api/openapi.json get /v1/inspections/{inspectionId}/payments
openapi: 3.1.0
info:
  title: Hive Inspect API
  version: 1.0.0
  description: Connect other tools to your Hive Inspect contacts, inspections and events.
servers:
  - url: https://api.hiveinspect.com
security:
  - bearerAuth: []
tags:
  - name: Contacts
    description: Agents, clients and every other contact in your organization.
  - name: Agencies
    description: The brokerages your agents belong to. Read-only.
  - name: Inspections
    description: Read-only access to your inspections.
  - name: Attachments
    description: Additional reports and additional documents on an inspection.
  - name: Events
    description: Extra appointments on an inspection, such as a radon drop-off or pick-up.
paths:
  /v1/inspections/{inspectionId}/payments:
    get:
      tags:
        - Inspections
      summary: Get an inspection's payments
      description: >-
        The invoice, what each payer owes, every payment with its Stripe id and
        whether it has settled, every refund, and bank payments the bank
        rejected. Read-only. Amounts are in the account's currency.
      operationId: listInspectionPayments
      parameters:
        - name: inspectionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InspectionPayments'
        '401':
          description: Missing, invalid or inactive API key
        '404':
          description: Not found
        '429':
          description: Rate limit exceeded (120 requests/minute per key owner)
components:
  schemas:
    InspectionPayments:
      type: object
      properties:
        inspection_id:
          type: string
          format: uuid
        payment_status:
          type:
            - string
            - 'null'
          description: >-
            Overall status, the same value as price.payment_status on the
            inspection.
        paid:
          type: boolean
          description: payment_status is paid.
        settled:
          type: boolean
          description: >-
            True only when the inspection is paid, nothing is owed by any payer,
            and no payment is still processing, awaiting closing or unknown. Use
            this before treating an inspection as fully paid.
        has_refunds:
          type: boolean
          description: At least one refund is pending or succeeded.
        currency:
          type: string
          description: usd or cad.
        total:
          type:
            - number
            - 'null'
          description: Services total across every payer, without the technology fee.
        amount_paid:
          type:
            - number
            - 'null'
          description: Services amount collected across every payer, after refunds.
        amount_due:
          type:
            - number
            - 'null'
          description: Services amount still owed across every payer.
        invoice:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
            order_id:
              type:
                - integer
                - 'null'
              description: The order number (OID) shown in Hive.
            invoice_number:
              type:
                - string
                - 'null'
              description: For example INV-2026-000123.
            created_at:
              type:
                - string
                - 'null'
              description: UTC.
              format: date-time
        shares:
          type: array
          items:
            $ref: '#/components/schemas/PaymentShare'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
        refunds:
          type: array
          items:
            $ref: '#/components/schemas/Refund'
        failed_bank_payments:
          type: array
          items:
            $ref: '#/components/schemas/FailedBankPayment'
      example:
        inspection_id: 3f2a9c1e-5b7d-4e2a-9f1c-6d8e7a5b4c3d
        payment_status: partial
        paid: false
        settled: false
        has_refunds: false
        currency: usd
        total: 550
        amount_paid: 400
        amount_due: 150
        invoice:
          id: 8d1c2b3a-4f5e-4a6b-9c7d-0e1f2a3b4c5d
          order_id: 123
          invoice_number: INV-2026-000123
          created_at: '2026-09-20T15:04:11Z'
        shares:
          - id: primary
            primary: true
            payer:
              contact_id: null
              name: Dana Reyes
              email: dana@example.com
            amount: 400
            amount_paid: 400
            amount_due: 0
            status: paid
            paid_at: null
          - id: c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f
            primary: false
            payer:
              contact_id: 0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f
              name: Sam Ortiz
              email: sam@example.com
            amount: 150
            amount_paid: 0
            amount_due: 150
            status: pending
            paid_at: null
        payments:
          - id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
            share_id: primary
            date: '2026-09-21'
            amount: 416
            services_amount: 400
            method: card
            status: settled
            stripe_payment_intent_id: pi_3Qx8mT2eZvKYlo2C1a2b3c4d
            card_brand: visa
            card_last4: '4242'
        refunds: []
        failed_bank_payments: []
    PaymentShare:
      type: object
      description: What one payer owes for the inspection.
      properties:
        id:
          type: string
          description: >-
            "primary" for the main client, otherwise the payer share's id
            (uuid).
        primary:
          type: boolean
        payer:
          type: object
          properties:
            contact_id:
              type:
                - string
                - 'null'
              description: The contact, when the share was sent to one.
              format: uuid
            name:
              type:
                - string
                - 'null'
              description: Payer name.
            email:
              type:
                - string
                - 'null'
              description: Payer email.
        amount:
          type:
            - number
            - 'null'
          description: >-
            Services amount this payer is responsible for, without the
            technology fee.
        amount_paid:
          type:
            - number
            - 'null'
          description: Services amount collected from this payer.
        amount_due:
          type:
            - number
            - 'null'
          description: Services amount this payer still owes.
        status:
          type: string
          enum:
            - pending
            - partial
            - processing
            - paid
          description: processing = a payment from this payer has not settled yet.
        paid_at:
          type:
            - string
            - 'null'
          description: >-
            When a payer share was paid. Null for the primary share; see its
            payments.
    Payment:
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
          description: >-
            Payment id. Null for a few old records and for a bank payment Hive
            is still waiting on.
        share_id:
          type: string
          description: The share this payment belongs to ("primary" or a share id).
        date:
          type:
            - string
            - 'null'
          description: Payment date, YYYY-MM-DD.
        amount:
          type:
            - number
            - 'null'
          description: >-
            Amount charged, including the technology fee on card payments. For a
            payer share this is worked out from the services amount and can
            differ from Stripe by a cent.
        services_amount:
          type:
            - number
            - 'null'
          description: The part of the amount that paid for services (no technology fee).
        method:
          type: string
          enum:
            - card
            - ach
            - affirm
            - cash
            - check
            - zelle
            - venmo
            - cash_app
            - e_transfer
            - wire_transfer
            - pay_at_close
            - other
        status:
          type: string
          enum:
            - settled
            - processing
            - awaiting_closing
            - unknown
          description: >-
            settled = the money has arrived. processing = a bank payment still
            clearing. awaiting_closing = pay at close, not collected yet.
            unknown = Stripe could not confirm it; ask again later.
        stripe_payment_intent_id:
          type:
            - string
            - 'null'
          description: >-
            Stripe PaymentIntent id (pi_...) on your Stripe account. Null for
            payments not taken through Stripe.
        card_brand:
          type:
            - string
            - 'null'
          description: Card brand, when known.
        card_last4:
          type:
            - string
            - 'null'
          description: Last 4 digits of the card, when known.
    Refund:
      type: object
      properties:
        id:
          type: string
          format: uuid
        share_id:
          type: string
          description: >-
            Always "primary" today: refunds of a payer share's payment are not
            recorded.
        amount:
          type:
            - number
            - 'null'
          description: Amount returned to the payer.
        services_amount:
          type:
            - number
            - 'null'
          description: The part of the refund that was for services (no technology fee).
        status:
          type: string
          enum:
            - pending
            - succeeded
            - failed
            - canceled
          description: A failed or canceled refund did not return money and is not counted.
        type:
          type: string
          enum:
            - stripe
            - manual
          description: manual = recorded in Hive, money returned outside Stripe.
        method:
          type:
            - string
            - 'null'
          enum:
            - card
            - ach
            - affirm
            - cash
            - check
            - zelle
            - venmo
            - cash_app
            - e_transfer
            - wire_transfer
            - pay_at_close
            - other
            - null
        stripe_refund_id:
          type:
            - string
            - 'null'
          description: Stripe Refund id (re_...).
        stripe_payment_intent_id:
          type:
            - string
            - 'null'
          description: The Stripe payment that was refunded.
        created_at:
          type:
            - string
            - 'null'
          description: When the refund was created (UTC).
          format: date-time
    FailedBankPayment:
      type: object
      description: >-
        A bank payment the bank rejected. Hive removed it from the payments, and
        the inspection is unpaid again.
      properties:
        stripe_payment_intent_id:
          type:
            - string
            - 'null'
          description: Stripe PaymentIntent id (pi_...).
        amount:
          type:
            - number
            - 'null'
          description: Amount that was rejected.
        method:
          type: string
          enum:
            - card
            - ach
            - affirm
            - cash
            - check
            - zelle
            - venmo
            - cash_app
            - e_transfer
            - wire_transfer
            - pay_at_close
            - other
        failed_at:
          type:
            - string
            - 'null'
          description: When Hive recorded the rejection.
        failure_code:
          type:
            - string
            - 'null'
          description: Stripe's reason code, for example insufficient_funds.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key from Business Tools → API Access.

````

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