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

# Create Payment

> Record a MANUAL / EXTERNAL payment (cash, bank transfer, off-platform).

This endpoint NEVER initiates a real charge. `payment_type` must be `external`
— any Stripe/processor value (single_session, group_session, package_redemption)
is rejected with 422, because a real charge must flow through the Stripe
PaymentIntent + webhook that keeps `session_ledger` consistent; the Python
backend does not own money flows.

`organization_id` and `created_at` are server-set; `stripe_payment_intent_id`
is always null. The referenced `session_id` (and any
`student_id`/`tutor_id`) must be org-scoped (404 otherwise). Honours
`Idempotency-Key`.



## OpenAPI

````yaml /openapi.json post /v1/payments
openapi: 3.1.0
info:
  title: EquateIt Public API
  description: >-
    REST API for EquateIt tutoring organisations. Pipe your sessions, invoices,
    payments, tutor earnings, students, and more into your own tools. Most
    endpoints are reads; a focused set of writes (each gated by a *:write scope)
    create or update data, including creating student/tutor/parent accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=ei_live_...

    Mint keys in the EquateIt app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/payments:
    post:
      tags:
        - Billing
      summary: Create Payment
      description: >-
        Record a MANUAL / EXTERNAL payment (cash, bank transfer, off-platform).


        This endpoint NEVER initiates a real charge. `payment_type` must be
        `external`

        — any Stripe/processor value (single_session, group_session,
        package_redemption)

        is rejected with 422, because a real charge must flow through the Stripe

        PaymentIntent + webhook that keeps `session_ledger` consistent; the
        Python

        backend does not own money flows.


        `organization_id` and `created_at` are server-set;
        `stripe_payment_intent_id`

        is always null. The referenced `session_id` (and any

        `student_id`/`tutor_id`) must be org-scoped (404 otherwise). Honours

        `Idempotency-Key`.
      operationId: create_payment_v1_payments_post
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PaymentCreate:
      properties:
        session_id:
          type: string
          title: Session Id
        student_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Student Id
        tutor_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Tutor Id
        amount_cents:
          type: integer
          minimum: 0
          title: Amount Cents
          description: Cents. Must be >= 0.
        currency:
          type: string
          title: Currency
          default: aud
        payment_type:
          type: string
          title: Payment Type
          description: >-
            Only 'external' is accepted (manual/off-platform). Stripe types are
            rejected.
          default: external
        status:
          type: string
          title: Status
          description: succeeded | pending | failed
          default: succeeded
      additionalProperties: false
      type: object
      required:
        - session_id
        - amount_cents
      title: PaymentCreate
      description: >-
        POST /v1/payments → session_payments. MANUAL / EXTERNAL payments ONLY.


        `payment_type` is restricted to 'external' — this endpoint NEVER
        initiates a

        real charge. Stripe/processor payment_types (single_session,
        group_session,

        package_redemption) are rejected with 422 because the Python backend
        does not

        own money flows: a real charge must go through the Stripe PaymentIntent
        +

        webhook that drives session_ledger. The referenced session/student/tutor
        must

        be org-scoped.
    Payment:
      properties:
        id:
          type: string
          title: Id
        session_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id
        student_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Student Id
        tutor_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Tutor Id
        amount_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Amount Cents
        refund_amount_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Refund Amount Cents
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        payment_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Payment Type
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        stripe_payment_intent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Stripe Payment Intent Id
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
      title: Payment
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````