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

# Cancel a scheduled payout

> Sets status to CANCELLED (terminal). Idempotent on an already-cancelled schedule.



## OpenAPI

````yaml /openapi.json delete /api/v1/business/payouts/schedules/{id}
openapi: 3.0.0
info:
  title: Axra Public API
  description: Merchant and third-party developer API surface
  version: '2026-04-15'
  contact: {}
servers:
  - url: http://localhost:3001
    description: Local development
  - url: https://staging-api.useaxra.com
    description: Staging
  - url: https://api.useaxra.com
    description: Production
security: []
tags: []
paths:
  /api/v1/business/payouts/schedules/{id}:
    delete:
      tags:
        - Business Payout Schedules
      summary: Cancel a scheduled payout
      description: >-
        Sets status to CANCELLED (terminal). Idempotent on an already-cancelled
        schedule.
      operationId: SchedulePayoutsController_cancel
      parameters:
        - name: X-Axra-Business-Id
          in: header
          description: Active business context
          required: false
          schema:
            type: string
        - name: x-api-key
          in: header
          description: Merchant API key (alternative to dashboard JWT)
          required: false
          schema:
            type: string
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/ScheduleResponseDto'
                required:
                  - success
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpErrorEnvelopeDto'
      security:
        - bearer: []
components:
  schemas:
    ScheduleResponseDto:
      type: object
      properties:
        id:
          type: string
        businessId:
          type: string
        name:
          type: string
          description: Human label, e.g. "Monthly payroll".
        cadence:
          type: string
          enum:
            - ONCE
            - WEEKLY
            - BIWEEKLY
            - MONTHLY
        dayOfMonth:
          type: object
          nullable: true
          description: MONTHLY day-of-month (1–28). Null for other cadences.
        payloadKind:
          type: string
          enum:
            - SINGLE
            - BATCH
        status:
          type: string
          enum:
            - ACTIVE
            - PAUSED
            - COMPLETED
            - CANCELLED
        itemCount:
          type: number
          description: Number of payout specs in the frozen payload.
        nextRunAt:
          type: string
          description: When the next run fires (ISO-8601).
        lastRunAt:
          type: object
          nullable: true
          description: When the last run fired (ISO-8601).
        endAt:
          type: object
          nullable: true
          description: Optional natural end (ISO-8601).
        runCount:
          type: number
          description: How many times this schedule has run.
        maxRunAmountUsd:
          type: string
          description: Per-run USD cap (compliance).
        maxRunLocalCaps:
          nullable: true
          description: >-
            Per-currency run caps, or null for USD-only capping. A currency
            listed here is checked against the run total in that currency, so it
            does not breach on FX movement alone.
          type: array
          items:
            $ref: '#/components/schemas/ScheduleLocalCapDto'
        authorizedAt:
          type: string
          description: When PIN + screening were completed at creation (ISO-8601).
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - businessId
        - name
        - cadence
        - payloadKind
        - status
        - itemCount
        - nextRunAt
        - runCount
        - maxRunAmountUsd
        - authorizedAt
        - createdAt
        - updatedAt
    HttpErrorEnvelopeDto:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          $ref: '#/components/schemas/HttpErrorBodyDto'
      required:
        - success
        - error
    ScheduleLocalCapDto:
      type: object
      properties:
        currency:
          type: string
          example: NGN
          description: Destination currency this cap applies to.
        amount:
          type: string
          example: '20000000'
          description: >-
            Maximum total destination amount per run in `currency`. Compared
            against the sum of the run's destination amounts in that currency —
            never converted, so it does not move with FX.
      required:
        - currency
        - amount
    HttpErrorBodyDto:
      type: object
      properties:
        code:
          type: string
          example: VALIDATION_ERROR
        message:
          type: string
          example: email must be an email
        statusCode:
          type: number
          example: 400
        errors:
          type: object
          description: >-
            Optional per-field validation messages (when present on the source
            exception)
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - code
        - message
        - statusCode
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````