> ## 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 Scheduled Payout

> Cancel a scheduled payout payment that is set to run in the future. This endpoint is useful if you need to stop a planned payout that has not yet been processed, allowing you to make adjustments or halt the transaction before it occurs.




## OpenAPI

````yaml /api/openapi/v1-reference.yaml post /v1/payouts/cancel_scheduled
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/payouts/cancel_scheduled:
    post:
      tags:
        - AUD Payout
      summary: Cancel Scheduled Payout
      description: >
        Cancel a scheduled payout payment that is set to run in the future. This
        endpoint is useful if you need to stop a planned payout that has not yet
        been processed, allowing you to make adjustments or halt the transaction
        before it occurs.
      operationId: cancelScheduledPayout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - payout_payment_uuid
              properties:
                payout_payment_uuid:
                  type: string
                  description: >
                    Unique identifier (UUID) for the scheduled payout payment to
                    be cancelled. This ID is used to locate and cancel the
                    specific payout transaction.
                  example: 123e4567-e89b-12d3-a456-426614174000
      responses:
        '200':
          description: Successfully cancelled the scheduled payout payment.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: >-
                      The updated status of the payout payment after
                      cancellation.
                    example: expired
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Entity

````

## Related topics

- [Multi-Currency Payout API Reference (v2)](/api/v2/payout.md)
- [Payment APIs for AUD (v1)](/api/v1/introduction.md)
- [Cancel a Scheduled Payout](/api/payout/cancel-a-scheduled-payout.md)