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

# Cancel



## OpenAPI

````yaml PATCH /one-time-payment/{id}/cancel
openapi: 3.1.0
info:
  title: Compago API
  version: 1.0.0
  description: >-
    Public and private API endpoints for Compago's payment infrastructure. This
    specification currently includes endpoints for one-time payments. More
    endpoints will be added as the platform evolves.
servers:
  - url: https://demo.api.harmony.compago.com/api
  - url: https://api.harmony.compago.com/api
security: []
tags:
  - name: OneTimePayment
    description: Endpoints for creating and processing one-time payment links
  - name: PaymentMethod
    description: >-
      Endpoints for saving cards, charging saved payment methods, and processing
      refunds
  - name: PaymentIntent
    description: >-
      Endpoints for creating and managing card-present payment intents for POS
      terminal integrations
paths:
  /one-time-payment/{id}/cancel:
    patch:
      tags:
        - OneTimePayment
      summary: Cancel a one-time payment
      operationId: cancelOneTimePayment
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The unique identifier of the one-time payment to cancel
      responses:
        '200':
          description: Payment successfully cancelled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelOneTimePaymentResponse'
        '400':
          description: Cannot cancel payment (not PENDING or already expired)
        '401':
          description: Unauthorized – missing or invalid API key
        '404':
          description: Payment not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CancelOneTimePaymentResponse:
      type: object
      description: The cancelled one-time payment object
      properties:
        id:
          type: string
          format: uuid
          example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
        status:
          type: string
          enum:
            - CANCELLED
        description:
          type: string
        amount:
          type: number
          format: decimal
        currency:
          type: string
        externalId:
          type: string
        expiresAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - status
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````