> ## 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.

# Reembolsar um Payin

Este endpoint permite que você reembolse integralmente uma transação Payin previamente autorizada.

**Requisitos para reembolso**:

* O valor do reembolso deve ser igual ao valor original do pagamento.
* O reembolso deve ser enviado para o mesmo beneficiário e conta utilizados no pagamento original.


## OpenAPI

````yaml openapi/pt-br/localpayment.json PATCH /api/payin/{externalId}/refund
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/payin/{externalId}/refund:
    patch:
      summary: Reembolsar um Payin
      operationId: refund-a-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 por você para rastreabilidade da transação. Deve ser único
            e aceita apenas caracteres alfanuméricos e hífens (UUID4, por
            exemplo).
          required: true
          schema:
            type: string
            pattern: '[a-zA-Z0-9\- ]+'
            examples:
              - 53025bf4-4c87-4b4f-8fea-b47004440f37
      requestBody:
        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. **Necessário apenas para
                    Pix (Brasil) e reembolsos em dinheiro.**
                beneficiary:
                  type: object
                  description: >-
                    Objeto com detalhes sobre o beneficiário do reembolso.
                    **Necessário apenas para reembolsos via Pix (Brasil) e em
                    dinheiro.**
                  properties:
                    type:
                      type: string
                      enum:
                        - COMPANY
                        - INDIVIDUAL
                      description: 'Tipo de beneficiário (ex.: `INDIVIDUAL`, `COMPANY`).'
                    name:
                      type: string
                      description: >-
                        Nome do beneficiário. Os caracteres permitidos dependem
                        do campo `type`: para `individual`, letras (incluindo
                        caracteres acentuados), espaços e pontos (`.`); para
                        `company`, o mesmo conjunto mais dígitos, sublinhado
                        (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    lastname:
                      type: string
                      description: >-
                        Sobrenome do beneficiário. Obrigatório quando `type` é
                        `individual` e ignorado quando `type` é `company`. Os
                        caracteres permitidos dependem de `type`: para
                        `individual`, letras (incluindo caracteres acentuados),
                        espaços e pontos (`.`); para `company`, o mesmo conjunto
                        mais dígitos, sublinhado (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    document:
                      type: object
                      properties:
                        type:
                          type: string
                          description: >-
                            O tipo de [documento de
                            identidade](/pt-br/reference/identity-document-types),
                            como Número de Identidade Nacional, Número de Seguro
                            Social ou Carteira de Motorista, dependendo do país
                            de emissão.
                        id:
                          type: string
                          description: >-
                            Número do documento de identidade (geralmente um
                            número). Este número deve ser válido de acordo com
                            as regras para o tipo específico de documento.
                    bank:
                      type: object
                      description: Dados bancários do beneficiário.
                      properties:
                        name:
                          type: string
                          description: Nome do banco.
                        code:
                          type: string
                          description: 'Código bancário. '
                        account:
                          type: object
                          description: 'Dados bancários do beneficiário. '
                          properties:
                            type:
                              type: string
                              description: 'Tipo de conta bancária (por exemplo, `C`, `S`). '
                            number:
                              type: string
                              description: Número da conta bancária.
                          required:
                            - type
                            - number
                        branch:
                          type: object
                          description: '**Somente o Brasil.** '
                          properties:
                            code:
                              type: string
                              description: Código da agência (de 1 a 5 dígitos).
                            name:
                              type: string
                              description: 'Nome da agência. '
                      required:
                        - name
                        - code
                        - account
                  required:
                    - type
                    - name
                    - bank
                comment:
                  type: string
                  description: >-
                    Comentário ou observação com informações adicionais sobre a
                    transação de reembolso.
              required:
                - externalId
                - beneficiary
              x-examples:
                Example 1:
                  comment: Refund API VA
                  beneficiary:
                    type: Type
                    name: Name
                    lastname: LastName
                    document:
                      type: DocumentType
                      id: DocumentId
                    bank:
                      name: BankName
                      code: Code
                      account:
                        type: BankAccountType
                        number: AccountNumber
            examples:
              Pix (Brazil) Refund:
                value:
                  comment: Pix refund
                  beneficiary:
                    type: INDIVIDUAL
                    name: John
                    lastname: Doe
                    document:
                      type: DocumentType
                      id: DocumentId
                    bank:
                      name: BankName
                      code: Code
                      account:
                        type: BankAccountType
                        number: AccountNumber
              902 - The payin was refunded:
                value:
                  externalId: e9407459-1ecc-4e18-800b-4bbae006afe2
                  internalId: 3e90d58c-8d3a-4c75-916e-a6d0add4f3b3
                  status:
                    code: '902'
                    description: REFUNDED
                    detail: The payin was refunded
              Cash refund:
                value:
                  comment: Cash refund
                  beneficiary:
                    type: INDIVIDUAL
                    name: John
                    lastname: Doe
                    document:
                      type: DocumentType
                      id: DocumentId
                    bank:
                      name: BankName
                      code: Code
                      account:
                        type: BankAccountType
                        number: AccountNumber
              Capture refund:
                value:
                  comment: Credit Card refund
      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).
                        examples:
                          - '902'
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                        examples:
                          - REFUNDED
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                        examples:
                          - The payin was refunded
                x-examples:
                  Example 1:
                    externalId: '{{ExternalId}}'
                    internalId: '{{InternalId}}'
                    status:
                      code: '902'
                      description: REFUNDED
                      detail: The payin was refunded
              examples:
                902 - The payin was refunded.:
                  value:
                    externalId: e36ef929-c2d4-fcf0-b30c-99dc51798f4b
                    internalId: c09095fb-6a0e-47af-9f43-3d9452b0f290
                    status:
                      code: '902'
                      description: REFUNDED
                      detail: The payin was refunded
        '400':
          description: Solicitação inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    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.
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                x-examples:
                  Example 1:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
              examples:
                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
                    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.
                      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:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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