> ## 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 um Payin

Este endpoint permite cancelar uma transação Payin que esteja autorizada. A transação será marcada como cancelada e quaisquer fundos pendentes serão liberados.


## OpenAPI

````yaml openapi/pt-br/localpayment.json PATCH /api/transactions/{externalId}/status
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/transactions/{externalId}/status:
    patch:
      summary: Cancelar um Payin
      operationId: cancel-payin
      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
        - name: externalId
          in: path
          description: >-
            ID gerado internamente para rastreabilidade da transação. Deve ser
            único e aceita apenas caracteres alfanuméricos e hífens (UUID4, por
            exemplo). Você também pode recuperar o status de uma transação
            usando seu ID interno.
          required: true
          schema:
            type: string
            pattern: '[a-zA-Z0-9\- ]+'
            examples:
              - 53025bf4-4c87-4b4f-8fea-b47004440f37
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  const: CANCELLED
                  description: Alterar o status para `CANCELLED`.
              required:
                - status
              x-examples:
                Example 1:
                  status: CANCELLED
            examples:
              CANCELLED:
                value:
                  status: CANCELLED
      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:
                    $ref: '#/components/schemas/status'
                x-examples:
                  Example 1:
                    externalId: '1623539480'
                    internalId: 764355d7-9935-4716-8e26-0f507ba2e6f8
                    status:
                      code: '900'
                      description: CANCELLED
                      detail: The payin was cancelled
              examples:
                900 - The payin was cancelled.:
                  value:
                    externalId: e36ef929-c2d4-fcf0-b30c-99dc51798f4b
                    internalId: c09095fb-6a0e-47af-9f43-3d9452b0f290
                    status:
                      code: '900'
                      description: CANCELLED
                      detail: The payin was cancelled
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  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.
                  errors:
                    type: array
                    description: Lista de erros que ocorreram durante a transação.
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Código de erro.
                        description:
                          type: string
                          description: Descrição do erro.
                        detail:
                          type: string
                          description: Detalhes adicionais.
                x-examples:
                  Example 1:
                    status:
                      code: '300'
                      description: REJECTED
                      detail: Invalid param + [status] + [Is mandatory]
                    errors:
                      - code: '300'
                        description: REJECTED
                        detail: Invalid param + [status] + [Is mandatory]
              examples:
                300 - Invalid param.:
                  value:
                    status:
                      code: '300'
                      description: REJECTED
                      detail: Invalid param + [status] + [Is mandatory]
                    errors:
                      - code: '300'
                        description: REJECTED
                        detail: Invalid param + [status] + [Is mandatory]
                400 - Invalid operation.:
                  value:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
        '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: object
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: Descrição do status.
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                x-examples:
                  Example 1:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Payin not found
              examples:
                404 - Payin not found:
                  value:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Payin not found
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  schemas:
    status:
      type: object
      title: status
      description: Status da operação.
      properties:
        code:
          type: string
          description: Código de status.
        description:
          type: string
          description: Descrição do status.
        detail:
          type: string
          description: Informações adicionais sobre o status.
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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