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

# Cancel Payout

> PAY-8 (B-007): cancel a STUCK in-flight payout (approved|disbursing →
cancelled).

A payout that was approved/marked-disbursing but can never be paid (the
external rail bounced, the provider rejected, the account was force-closed)
was previously irrecoverable: the partial-unique `one-in-flight-per-account`
index then made EVERY later cycle's payout_request INSERT fail, and the
generator's blanket-except rolled back + re-failed every 10 minutes forever.
Cancelling clears the in-flight slot so the account's pipeline can advance.

Terminal: cancelled is final (status CHECK allows it). Only approved or
disbursing rows can be cancelled — a `paid` row is real money already wired
(use chargeback/correction instead) and a `pending` row should be `reject`ed.
Requires the `disburse_payout` permission (same gate as mark-disbursing /
mark-paid — only a disbursement operator should void an in-flight payout).
No money moves: the PAY-1 synthetic-book debit happens at mark-paid, which a
cancelled payout never reaches, so there is nothing to reverse here.



## OpenAPI

````yaml /openapi.json post /prop/payouts/{payout_id}/cancel
openapi: 3.1.0
info:
  title: Slate API
  version: 1.0.0
  description: Trading infrastructure API.
servers:
  - url: https://api.{your-broker}.slate-labs.com
    variables:
      your-broker:
        default: broker
security: []
tags:
  - name: Authentication
  - name: API Tokens
  - name: Customers
  - name: Accounts
  - name: Orders
  - name: Instruments & Groups
  - name: Transactions
  - name: Payments
  - name: Transfers
  - name: Risk
  - name: Workflow & CRM
  - name: Messaging
  - name: Integrations
  - name: Webhooks
  - name: Compliance
  - name: Promo codes
  - name: Reporting
  - name: Audit
  - name: Fraud & moderation
  - name: Broker settings
  - name: Users
  - name: Roles & Teams
  - name: Streams (SSE)
  - name: Simulator
  - name: Observability
  - name: Prop trading
paths:
  /prop/payouts/{payout_id}/cancel:
    post:
      tags:
        - Prop trading
      summary: Cancel Payout
      description: >-
        PAY-8 (B-007): cancel a STUCK in-flight payout (approved|disbursing →

        cancelled).


        A payout that was approved/marked-disbursing but can never be paid (the

        external rail bounced, the provider rejected, the account was
        force-closed)

        was previously irrecoverable: the partial-unique
        `one-in-flight-per-account`

        index then made EVERY later cycle's payout_request INSERT fail, and the

        generator's blanket-except rolled back + re-failed every 10 minutes
        forever.

        Cancelling clears the in-flight slot so the account's pipeline can
        advance.


        Terminal: cancelled is final (status CHECK allows it). Only approved or

        disbursing rows can be cancelled — a `paid` row is real money already
        wired

        (use chargeback/correction instead) and a `pending` row should be
        `reject`ed.

        Requires the `disburse_payout` permission (same gate as mark-disbursing
        /

        mark-paid — only a disbursement operator should void an in-flight
        payout).

        No money moves: the PAY-1 synthetic-book debit happens at mark-paid,
        which a

        cancelled payout never reaches, so there is nothing to reverse here.
      operationId: cancel_payout_prop_payouts__payout_id__cancel_post
      parameters:
        - name: payout_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Payout Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoutCancelRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: Response Cancel Payout Prop Payouts  Payout Id  Cancel Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    PayoutCancelRequest:
      properties:
        reason:
          type: string
          maxLength: 500
          minLength: 1
          title: Reason
      type: object
      required:
        - reason
      title: PayoutCancelRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````