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

# Report a deal payment paid

> Reserved clusters: the buyer reports a payment of its deal (the down payment, an installment, a recurring payment; one of the request's `deal.payments`) paid to the owner, with the day and a reference. Runcrate never receives the money: the buyer pays the owner directly, and the owner is asked to confirm it arrived. Reporting again corrects the report; the same report again changes nothing. Owners and admins of the workspace signed in to the dashboard only: an API key or an agent is refused (403).



## OpenAPI

````yaml /api-reference/openapi.json post /capacity/requests/{id}/payments/{paymentId}/report
openapi: 3.1.0
info:
  title: Runcrate API
  version: 1.0.0
  summary: OpenAI-compatible inference API + GPU infrastructure API.
  description: >-
    Runcrate exposes two API surfaces. The inference API at
    `https://api.runcrate.ai/v1` is OpenAI-compatible: it accepts the standard
    OpenAI SDK with the base URL changed. The infrastructure API at
    `https://www.runcrate.ai/api/v1` manages GPU instances, jobs, persistent
    volumes, environments, SSH keys, templates, and billing. Both share a single
    `rc_live_*` API key.


    Pricing is per-token, per-image, per-second, or per-minute on the inference
    API (varies by model; see https://www.runcrate.ai/api/models/catalog for
    live rates) and per-second on GPU rentals (see
    https://www.runcrate.ai/pricing for hourly rates per GPU class).


    All infrastructure API responses are wrapped in `{ "data": ... }`. List
    responses also include a `meta` object with pagination cursors. Error
    responses use `{ "error": { "code": "...", "message": "..." } }`.
  termsOfService: https://www.runcrate.ai/terms
  contact:
    name: Runcrate
    url: https://www.runcrate.ai/contact
  license:
    name: Proprietary
    url: https://www.runcrate.ai/terms
servers:
  - url: https://api.runcrate.ai/v1
    description: Inference API (OpenAI-compatible)
  - url: https://www.runcrate.ai/api/v1
    description: >-
      Infrastructure API (instances, jobs, storage, environments, ssh-keys,
      templates, billing)
security:
  - ApiKeyAuth: []
tags:
  - name: Chat
    description: OpenAI-compatible chat completions.
  - name: Messages
    description: Anthropic-compatible Messages API, for Claude Code and the Anthropic SDKs.
  - name: Responses
    description: >-
      OpenAI-compatible Responses API, for Codex and responses.create. Nothing
      is stored.
  - name: Images
    description: Text-to-image generation.
  - name: Videos
    description: Async text-to-video and image-to-video generation.
  - name: Audio
    description: Text-to-speech and speech-to-text.
  - name: Embeddings
    description: Vector embeddings for RAG and search.
  - name: Models
    description: Model catalog discovery.
  - name: Instances
    description: GPU instance lifecycle.
  - name: Jobs
    description: >-
      Run one command on its own GPU machine. The machine stops, and billing
      ends, when the command exits.
  - name: Schedules
    description: >-
      Start an instance or a job later: once at a set time, or on a repeating
      cron schedule in your timezone.
  - name: Clusters
    description: >-
      Multi-machine GPU clusters on a private network, with Slurm, Kubernetes or
      Ray, bought by the machine. All or nothing: every machine starts or none
      does, billed from when every machine is up.
  - name: Storage
    description: Persistent volume management.
  - name: Environments
    description: Resource isolation containers within a workspace.
  - name: Secrets
    description: >-
      Names of the secrets an environment's machines get. Values are set in the
      dashboard and never returned.
  - name: SSH Keys
    description: SSH key management for instance access.
  - name: Templates
    description: Pre-built instance images and configurations.
  - name: Billing
    description: >-
      Credit balance and runway, top-ups, auto-recharge, payment methods,
      transactions, usage metrics.
  - name: Model calls
    description: >-
      The log of calls to the inference API, kept 30 days: outcome, timing,
      tokens, cost, end user, session and tags. Never the prompt or the answer.
paths:
  /capacity/requests/{id}/payments/{paymentId}/report:
    post:
      tags:
        - Clusters
      summary: Report a deal payment paid
      description: >-
        Reserved clusters: the buyer reports a payment of its deal (the down
        payment, an installment, a recurring payment; one of the request's
        `deal.payments`) paid to the owner, with the day and a reference.
        Runcrate never receives the money: the buyer pays the owner directly,
        and the owner is asked to confirm it arrived. Reporting again corrects
        the report; the same report again changes nothing. Owners and admins of
        the workspace signed in to the dashboard only: an API key or an agent is
        refused (403).
      operationId: reportCapacityDealPayment
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The capacity request.
        - name: paymentId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: A payment of the request's `deal.payments`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - paidOn
              properties:
                paidOn:
                  type: string
                  format: date
                  description: >-
                    The day it was paid (YYYY-MM-DD): within the last year, not
                    in the future.
                reference:
                  type: string
                  maxLength: 200
                  description: >-
                    A reference the owner can match it by (a wire or transfer
                    reference).
            example:
              paidOn: '2026-11-18'
              reference: Wire 4471
      responses:
        '200':
          description: The payment as it stands now.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - id
                      - kind
                      - dueOn
                      - amountUsd
                      - payee
                      - status
                      - reportedBy
                      - confirmedAt
                    description: >-
                      A payment of the deal, from the buyer to the owner.
                      Runcrate never receives or holds it: it only tracks it.
                    properties:
                      id:
                        type: string
                        format: uuid
                      kind:
                        type: string
                        enum:
                          - down_payment
                          - installment
                          - recurring
                      dueOn:
                        type: string
                        format: date
                        description: YYYY-MM-DD.
                      amountUsd:
                        type: number
                      payee:
                        type: string
                        enum:
                          - owner
                      status:
                        type: string
                        enum:
                          - due
                          - reported_paid
                          - confirmed
                          - overdue
                        description: 'overdue: past its due day and not confirmed.'
                      reportedBy:
                        type:
                          - string
                          - 'null'
                        enum:
                          - buyer
                          - owner
                          - admin
                          - null
                      confirmedAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          When the owner (or Runcrate's desk) confirmed it
                          arrived.
              example:
                data:
                  id: 6f1d2c3a-1b2c-4d5e-8f90-1a2b3c4d5e6f
                  kind: down_payment
                  dueOn: '2026-11-18'
                  amountUsd: 81573.12
                  payee: owner
                  status: reported_paid
                  reportedBy: buyer
                  confirmedAt: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: A member who is not an owner or admin, or an API key or agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such request in this workspace, or no such payment on it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The payment is already confirmed, or the contract is not signed yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: paidOn or reference is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                Machine-readable error code (e.g. `validation_error`,
                `unauthorized`, `not_found`, `insufficient_credits`,
                `rate_limited`, `internal_error`).
            message:
              type: string
              description: Human-readable error message.
            details:
              type: object
              additionalProperties: true
              description: Optional structured error context.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Use a Runcrate API key with the `rc_live_*` prefix as the bearer token.
        Create one at https://www.runcrate.ai/dashboard/api-keys.

````

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