LuckPanda Payments API

openapi: 3.2.0
info:
  title: Luckpanda App Payments API
  version: 1.0.0
  description: 'Operations tagged Payments across 2 of this provider''s published API definitions: openapi.yaml, luckpanda-app-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://luckpanda.app/api/v1
- url: http://127.0.0.1:8787/api/v1
  description: Local `wrangler dev`
security:
- bearerAuth: []
tags:
- name: Payments
paths:
  /payment-receipts:
    get:
      tags:
      - Payments
      operationId: listPaymentReceipts
      x-mcp-tool: payment_receipt_list
      parameters:
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          $ref: '#/components/responses/Page'
      summary: List payment receipts
      x-summary-source: derived
    post:
      tags:
      - Payments
      operationId: recordPaymentReceipt
      x-mcp-tool: payment_receipt_record
      x-human-only-effect: true
      summary: Record money received and allocate it to invoices
      description: Server-integration keys need `payment.record:sales`, and every allocated document must be within the key's limits.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordPaymentReceipt'
      responses:
        '201':
          $ref: '#/components/responses/CommandAccepted'
        '403':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /payment-receipts/{receiptId}:
    get:
      tags:
      - Payments
      operationId: getPaymentReceipt
      x-mcp-tool: payment_receipt_get
      parameters:
      - $ref: '#/components/parameters/ReceiptId'
      responses:
        '200':
          $ref: '#/components/responses/Resource'
      summary: Get payment receipt
      x-summary-source: derived
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /payment-receipts/{receiptId}/reverse:
    post:
      tags:
      - Payments
      operationId: reversePaymentReceipt
      x-mcp-tool: payment_receipt_reverse
      description: Posted records are corrected by reversal only. People only.
      parameters:
      - $ref: '#/components/parameters/ReceiptId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolInput'
      responses:
        '200':
          $ref: '#/components/responses/CommandAccepted'
      summary: Reverse payment receipt
      x-summary-source: derived
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /payments:
    post:
      tags:
      - Payments
      operationId: recordPayment
      x-mcp-tool: payment_record_and_allocate
      x-human-only-effect: true
      description: 'The earlier single-invoice form (`action: record`). New integrations use `POST /payment-receipts` or `POST /invoices`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolInput'
      responses:
        '201':
          $ref: '#/components/responses/DocumentResult'
      summary: Record payment
      x-summary-source: derived
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /payments/{paymentId}/allocations:
    post:
      tags:
      - Payments
      operationId: allocatePayment
      x-mcp-tool: payment_record_and_allocate
      x-human-only-effect: true
      parameters:
      - $ref: '#/components/parameters/PaymentId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolInput'
      responses:
        '201':
          $ref: '#/components/responses/DocumentResult'
      summary: Allocate payment
      x-summary-source: derived
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
  /payment-accounts:
    get:
      tags:
      - Payments
      operationId: listPaymentAccounts
      x-mcp-tool: payment_account_list
      responses:
        '200':
          $ref: '#/components/responses/Page'
      summary: List payment accounts
      x-summary-source: derived
    servers:
    - url: https://luckpanda.app/api/v1
    - url: http://127.0.0.1:8787/api/v1
      description: Local `wrangler dev`
components:
  responses:
    Resource:
      description: Authorized resource
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
    Page:
      description: Cursor page
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Page'
    Problem:
      description: Typed RFC 7807 error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    DocumentResult:
      description: The document after the command, with the command result under `operation`. A proposal or a dry run returns the bare command result.
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/Document'
            - $ref: '#/components/schemas/CommandResult'
    CommandAccepted:
      description: 'Command result: succeeded, awaiting_approval (a proposal) or preview (dry_run)'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CommandResult'
  schemas:
    Document:
      type: object
      description: The document view (abridged).
      required:
      - id
      - kind
      - lifecycle
      - version
      properties:
        id:
          $ref: '#/components/schemas/Uuid'
        kind:
          type: string
        lifecycle:
          type: string
          enum:
          - draft
          - issued
          - cancelled
        settlement:
          type: string
          enum:
          - unpaid
          - part_paid
          - paid
          - overpaid
          - not_applicable
        version:
          type: integer
        currency:
          $ref: '#/components/schemas/Currency'
        payable_minor:
          type: integer
        paid_minor:
          type: integer
        external_ref:
          type:
          - string
          - 'null'
        doc:
          type: object
          description: 'The editor document: number, dates, parties, lines, totals'
          additionalProperties: true
        operation:
          $ref: '#/components/schemas/CommandResult'
      additionalProperties: true
    Date:
      type: string
      pattern: ^\d{4}-\d{2}-\d{2}$
    RecordPaymentReceipt:
      allOf:
      - $ref: '#/components/schemas/CommandBase'
      - type: object
        required:
        - kind
        - party_id
        - currency
        - received_on
        - lines
        properties:
          kind:
            type: string
            enum:
            - receipt
            - advance
          party_id:
            $ref: '#/components/schemas/Uuid'
          currency:
            $ref: '#/components/schemas/Currency'
          received_on:
            $ref: '#/components/schemas/Date'
          lines:
            type: array
            minItems: 1
            maxItems: 20
            items:
              type: object
              required:
              - amount_minor
              properties:
                amount_minor:
                  type: integer
                  minimum: 0
                fee_minor:
                  type: integer
                  minimum: 0
                withholding_minor:
                  type: integer
                  minimum: 0
                payment_account_id:
                  $ref: '#/components/schemas/Uuid'
                method:
                  type: string
                  enum:
                  - bank_transfer
                  - upi
                  - cash
                  - cheque
                  - demand_draft
                  - card
                  - wallet
                  - gateway
                  - other
                reference:
                  type: string
                  maxLength: 200
          allocations:
            type: array
            maxItems: 50
            items:
              type: object
              required:
              - document_id
              - amount_minor
              properties:
                document_id:
                  $ref: '#/components/schemas/Uuid'
                amount_minor:
                  type: integer
                  minimum: 1
                withholding_minor:
                  type: integer
                  minimum: 0
                document_revision_no:
                  type: integer
                  minimum: 1
          confirm_overpayment:
            type: boolean
            default: false
          fx_rate_to_base:
            type: string
          notes:
            type: string
            maxLength: 1000
    CommandResult:
      type: object
      required:
      - operation_id
      - status
      - correlation_id
      properties:
        operation_id:
          $ref: '#/components/schemas/Uuid'
        status:
          type: string
          enum:
          - succeeded
          - awaiting_approval
          - preview
        correlation_id:
          $ref: '#/components/schemas/Uuid'
        resource:
          type: object
          additionalProperties: true
        approval_request_id:
          $ref: '#/components/schemas/Uuid'
    Uuid:
      type: string
      format: uuid
    Problem:
      type: object
      required:
      - type
      - title
      - status
      - code
      properties:
        type:
          type: string
          format: uri-reference
        title:
          type: string
        status:
          type: integer
        code:
          type: string
          description: 'VALIDATION_FAILED (422) the body or a field is wrong; see field_errors.

            FORBIDDEN (401 no or revoked key, 403 missing permission or grant).

            NOT_FOUND (404).

            APPROVAL_REQUIRED (403) an agent (or any key over /mcp) tried to issue, send or pay; send proposal_only to propose instead.

            INTEGRATION_LIMIT (403) a server-integration key is outside its kinds, legal entities or largest total.

            PAYWALL (402) the business has not unlocked the outcome (issuing needs the Sales module); the body names the module.

            INVALID_STATE (409) the document is not in a state that allows this (e.g. issuing a cancelled document).

            STALE_VERSION (409) expected_version is behind; reload and retry.

            IDEMPOTENCY_MISMATCH (409) the idempotency_key was used with a different body.

            DUPLICATE_EXTERNAL_REF (409) a document of this kind already has this external_ref.

            COMPLIANCE_BLOCKED (409) a compliance rule blocks the change (e.g. cancelling a document with an active e-invoice IRN).

            ALLOCATION_EXCEEDS_AVAILABLE (409) a payment allocation is more than the receipt or the amount due allows.

            NOT_IMPLEMENTED (501) a path or option that is planned but not served.

            DELIVERY_FAILED (502, /invoices send step) the email provider refused the message.

            RATE_LIMITED (429).

            '
          enum:
          - VALIDATION_FAILED
          - FORBIDDEN
          - NOT_FOUND
          - APPROVAL_REQUIRED
          - INTEGRATION_LIMIT
          - PAYWALL
          - INVALID_STATE
          - STALE_VERSION
          - IDEMPOTENCY_MISMATCH
          - DUPLICATE_EXTERNAL_REF
          - COMPLIANCE_BLOCKED
          - ALLOCATION_EXCEEDS_AVAILABLE
          - CONFLICT
          - NOT_IMPLEMENTED
          - DELIVERY_FAILED
          - RATE_LIMITED
          - INTERNAL_ERROR
        message:
          type: string
        field_errors:
          type: array
          items:
            type: object
            required:
            - path
            - code
            properties:
              path:
                type: string
              code:
                type: string
        correlation_id:
          $ref: '#/components/schemas/Uuid'
    Page:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          maxItems: 100
          items:
            type: object
            additionalProperties: true
        next_cursor:
          type:
          - string
          - 'null'
    IdempotencyKey:
      type: string
      minLength: 16
      maxLength: 128
      pattern: ^[A-Za-z0-9._:-]+$
    Currency:
      type: string
      pattern: ^[A-Z]{3}$
    ToolInput:
      type: object
      description: The input schema of the operation's `x-mcp-tool` (minus the ids the path supplies). See `architecture/mcp-tools.json`.
      required:
      - idempotency_key
      - correlation_id
      additionalProperties: true
    CommandBase:
      type: object
      required:
      - idempotency_key
      - correlation_id
      properties:
        idempotency_key:
          $ref: '#/components/schemas/IdempotencyKey'
        correlation_id:
          $ref: '#/components/schemas/Uuid'
        dry_run:
          type: boolean
          default: false
        proposal_only:
          type: boolean
          default: false
          description: Make it a proposal for a person to accept instead of acting.
        approval_request_id:
          $ref: '#/components/schemas/Uuid'
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 50
        default: 25
    ReceiptId:
      name: receiptId
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Uuid'
    PaymentId:
      name: paymentId
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Uuid'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque API key, lpk_...
      description: Made in Workspace > Developers (agent or server-integration). Not a JWT.
x-refined-from:
- openapi.yaml
- luckpanda-app-openapi.yaml