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

# Cancel a PayID

> Cancel an active `pending` PayID transaction, which will deregister the PayID and update the transaction status to `expired`. This action is irreversible and will prevent the PayID from being used for further transactions.

This endpoint is useful when a customer decides not to complete the payment, or if the PayID needs to be invalidated for other reasons. Once cancelled, the PayID will no longer be recognised as valid within the system.




## OpenAPI

````yaml /api/openapi/v1-reference.yaml post /v1/payment_requests/cancel_payid
openapi: 3.0.3
info:
  title: Payment APIs (AUD only)
  description: >-
    ## Introduction

    The Payment API Solution (AUD) offers developers a comprehensive suite of
    API services to build innovative AUD payment solutions efficiently. These
    APIs enable seamless transactions using various payment methods and
    functionalities, ensuring a robust, reliable, and scalable payment
    infrastructure tailored for the Australian market.

    ### Key Features

    - **Payment Methods**:
      - **Payment Link**: Supports payments via card and PayID.
      - **PayID**: Provides instant payments using a unique identifier.
      - **PayTo**: Enables scheduled or recurring payments.
      - **BSB/Account Number**: Allows direct bank transfers.
      - **Payout**: Manage payouts to designated accounts.

    - **Additional Functionalities**:
      - **Balance Management**: Real-time balance inquiries and updates.
      - **Reporting Services**: Generate detailed transaction and payment reports.

    This documentation provides detailed guidance for integrating these
    capabilities into your application.
  termsOfService: https://helloclever.co/terms
  contact:
    email: support@helloclever.co
  version: 1.0.11
servers:
  - url: https://api.cleverhub.co/api
    description: Sandbox Environment
  - url: https://api-merchant.helloclever.co/api
    description: Production Environment
security: []
paths:
  /v1/payment_requests/cancel_payid:
    post:
      tags:
        - AUD PayID
      summary: Cancel a PayID
      description: >
        Cancel an active `pending` PayID transaction, which will deregister the
        PayID and update the transaction status to `expired`. This action is
        irreversible and will prevent the PayID from being used for further
        transactions.


        This endpoint is useful when a customer decides not to complete the
        payment, or if the PayID needs to be invalidated for other reasons. Once
        cancelled, the PayID will no longer be recognised as valid within the
        system.
      operationId: cancelPayID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - payid
              properties:
                payid:
                  type: string
                  description: >-
                    The unique PayID to be cancelled, associated with the
                    pending transaction.
                  example: abc.xyz@example.co
      responses:
        '200':
          description: PayID cancelled successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payid:
                    type: string
                    description: The PayID that was cancelled.
                    example: abc.xyz@example.co
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Entity
      security:
        - app-id: []
          secret-key: []
components:
  securitySchemes:
    app-id:
      type: apiKey
      in: header
      name: app-id
      description: |
        A unique identifier assigned to each application.
    secret-key:
      type: apiKey
      in: header
      name: secret-key
      description: |
        A secure token associated with the `app-id`.

````

## Related topics

- [Accept Instant Payments with AUD PayID](/developer-reference/api-use-cases/accept-instant-payments-with-aud-payid.md)
- [Cancel Payin](/api/payin/cancel-payin.md)
- [What NPP, PayID, and PayTo Are](/platform-overview/payment-concepts/npp-payid-payto.md)