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

# Cancelar Payout

Cancele um Payout para impedir que os fundos sejam transferidos. Use este recurso para interromper transações criadas por engano ou que precisem de correção.

> **Note**
>
> Você só pode cancelar Payouts com status **Bloqueado** ou **Em espera**. Para detalhes sobre as transições de status, consulte a documentação [Visão geral de Payout](https://docs.localpayment.com/pt-br/reference/create-a-payout.md).

Este endpoint protege suas transações garantindo que os fundos não sejam enviados ao destinatário errado ou com um valor incorreto.


## OpenAPI

````yaml openapi/pt-br/localpayment.json PATCH /api/payout/cancel
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/payout/cancel:
    patch:
      summary: Cancelar Payout
      operationId: void-a-payout
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                externalId:
                  type: string
                  description: ID da transação a ser anulada.
              required:
                - externalId
              x-examples:
                Example 1:
                  externalId: '1736488554'
            examples:
              Void a payout:
                value:
                  externalId: '1736488554'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: >-
                      Um identificador único gerado pelo seu sistema para
                      rastrear a transação (alfanumérico e com hífens).
                      Recomendamos o uso do UUID4 para garantir a unicidade.
                  internalId:
                    type: string
                    description: Identificador de transação da Localpayment.
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                required:
                  - externalId
                  - internalId
                  - status
                x-examples:
                  Example 1:
                    externalId: '1736488510'
                    internalId: 3d36811d-1c02-41ea-a576-68df62c4603a
                    status:
                      code: '900'
                      description: Cancelled
                      detail: The payout was cancelled
              examples:
                900 - Cancelled:
                  value:
                    externalId: '1736488510'
                    internalId: 3d36811d-1c02-41ea-a576-68df62c4603a
                    status:
                      code: '900'
                      description: Cancelled
                      detail: The payout was cancelled
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
        '404':
          description: Não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: integer
                    description: Código de status.
                  Message:
                    type: string
                    description: Mensagem com informações adicionais.
                  TraceId:
                    type: string
                    description: Identificador de rastreamento.
                required:
                  - Status
                  - Message
                  - TraceId
                x-examples:
                  Example 1:
                    Status: 404
                    Message: This transacion does not exists.
                    TraceId: d11cea70-7f14-4f11-b66e-13f5f56c2e56
              examples:
                404 - Transaction does not exists:
                  value:
                    Status: 404
                    Message: This transacion does not exists.
                    TraceId: dae2d1cb-7e9e-48a5-8530-980f38b31712
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.