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

# Ativar ou desativar uma Virtual Account

Este endpoint permite ativar ou desativar temporariamente uma Virtual Account. Use-o para suspender o recebimento de novos fundos em uma conta específica (desativar) ou para reativá-la e permitir que volte a aceitar pagamentos (ativar). Isso é útil para gerenciar contas de clientes durante análises de conformidade, pausar assinaturas ou aplicar outros controles operacionais.


## OpenAPI

````yaml openapi/pt-br/localpayment.json PUT /api/virtual-account/{externalId}/activation/{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/virtual-account/{externalId}/activation/{status}/:
    put:
      summary: Ativar ou desativar uma Virtual Account
      operationId: update-virtual-account-status
      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: status
          in: path
          description: '`enable` ou `disable`.'
          required: true
          schema:
            type: string
            enum:
              - enable
              - disable
            examples:
              - enable
        - name: externalId
          in: path
          description: >-
            O identificador único da Virtual Account que você deseja gerenciar.
            Este deve ser exatamente o mesmo valor de externalId fornecido ao
            criar a conta. Use este identificador para especificar a conta de
            destino para operações como ativá-la ou desativá-la.
          required: true
          schema:
            type: string
            pattern: '[a-zA-Z0-9\- ]+'
            examples:
              - 53025bf4-4c87-4b4f-8fea-b47004440f37
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    type: string
                    enum:
                      - ARS
                      - BRL
                      - CLP
                      - USD
                      - MXN
                      - PEN
                    description: '[código da moeda](/pt-br/reference/currency-codes).'
                  externalId:
                    type: string
                    description: >-
                      O identificador único da Virtual Account. Este é o mesmo
                      externalId fornecido em sua solicitação, confirmando que a
                      operação foi realizada na conta correta.
                  internalId:
                    type: string
                    description: Identificador de transação da Localpayment.
                  accountNumber:
                    type: string
                    description: Número da conta Localpayment.
                  beneficiary:
                    type: object
                    title: beneficiário
                    description: >-
                      A pessoa física ou jurídica que receberá os fundos
                      depositados nesta Virtual Account. O beneficiário é o
                      destinatário final do dinheiro e não é necessariamente o
                      proprietário ou titular legal da própria Virtual Account.
                    properties:
                      type:
                        type: string
                        enum:
                          - COMPANY
                          - INDIVIDUAL
                        description: Tipo de beneficiário.
                      name:
                        type: string
                        description: Nome do beneficiário.
                      document:
                        type: object
                        description: Documentação do beneficiário.
                        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.
                            examples:
                              - RUC
                          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.
                            examples:
                              - '1791234561009'
                        examples:
                          - type: RUC
                            id: '1791234561009'
                      lastName:
                        type: string
                        description: Sobrenome do beneficiário.
                      fullName:
                        type: string
                        description: Nome completo do beneficiário.
                      bank:
                        type: object
                        properties:
                          branch:
                            type: object
                            description: Detalhes da agência bancária.
                            properties:
                              code:
                                type: string
                                description: Código da agência.
                          account:
                            type: object
                            description: Dados bancários do beneficiário.
                            properties:
                              number:
                                type: string
                                description: Número da conta.
                              aliases:
                                type: array
                                description: >-
                                  Matriz de aliases da conta (por exemplo,
                                  identificadores únicos da conta).
                                items:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      description: 'O tipo de alias (ex.: `RandomKeyCode`).'
                                    value:
                                      type: string
                                      description: Valor do alias.
                              owner:
                                type: object
                                description: Detalhes do documento do titular da conta.
                                properties:
                                  document:
                                    type: object
                    examples:
                      - type: COMPANY
                        name: string
                        document:
                          type: RUC
                          id: '1791234561009'
                        lastName: string
                        fullName: string
                        bank:
                          branch: {}
                          account:
                            number: string
                            aliases:
                              - type: string
                                value: string
                            owner:
                              document: {}
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/validate-identity-document).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/validate-identity-document).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                  errors:
                    type: array
                    description: >-
                      Matriz de erros que ocorreram durante a transação. Se a
                      transação foi bem-sucedida, esta matriz estará vazia.
                    items:
                      type: object
                x-examples:
                  Example 1:
                    currency: MXN
                    externalId: e36ef959-12d4-4cf0-b00c-99dc51798f4b
                    internalId: c09095fb-6a0e-47ff-9143-9d9452b0f290
                    accountNumber: '{{accountNumber}}'
                    beneficiary:
                      type: INDIVIDUAL
                      name: FirtName
                      document:
                        type: RFC
                        id: EXTF900101NI1
                      bank:
                        branch: {}
                        account:
                          number: '646011319800023800'
                          aliases: []
                          owner:
                            document: {}
                      fullName: FirtName LastName
                      lastName: LastName
                    status:
                      code: '200'
                      description: COMPLETED
                      detail: Virtual account has been created
                    errors: []
              examples:
                200 - Virtual account has been created.:
                  value:
                    currency: MXN
                    externalId: e36ef929-c2d4-fcf0-b30c-99dc51798f4b
                    internalId: c09095fb-6a0e-47af-9f43-3d9452b0f290
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: INDIVIDUAL
                      name: John
                      document:
                        type: RFC
                        id: EXTF900101NI1
                      bank:
                        branch: {}
                        account:
                          number: '646011319800023123'
                          aliases: []
                          owner:
                            document: {}
                      fullName: John Doe
                      lastName: Doe
                    status:
                      code: '200'
                      description: COMPLETED
                      detail: Virtual account has been created
                    errors: []
                300 - Virtual account disabled.:
                  value:
                    currency: MXN
                    externalId: e36eff59-22d4-ccf0-bf0c-99dc51798f4b
                    internalId: c09095fb-6a4e-17cf-9343-9d9452b0f290
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    beneficiary:
                      type: INDIVIDUAL
                      name: John
                      document:
                        type: RFC
                        id: EXTF900101NI1
                      bank:
                        branch: {}
                        account:
                          number: '646011319800023123'
                          aliases: []
                          owner:
                            document: {}
                      fullName: John Doe
                      lastName: Doe
                    status:
                      code: '300'
                      description: DISABLED
                      detail: Virtual account disabled
                    errors: []
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: Tempo de execução do serviço.
                  status:
                    type: integer
                    description: Código de status do erro.
                  error:
                    type: string
                    description: Descrição do erro.
                  message:
                    type: string
                    description: Mensagem com informações adicionais.
                  path:
                    type: string
                    description: Caminho do serviço.
                x-examples:
                  Example 1:
                    timestamp: '2025-01-06T23:55:22.121+00:00'
                    status: 400
                    error: Bad Request.
                    message: >-
                      Status activation not recognize. Please use 'disable' or
                      'enable'
                    path: >-
                      /virtual-account/e36ef959-12d4-4cf0-b00c-99dc51798f4b/activation/:status
              examples:
                400 - Status activation not recognize.:
                  value:
                    timestamp: '2025-01-06T23:55:22.121+00:00'
                    status: 400
                    error: Bad Request.
                    message: >-
                      Status activation not recognize. Please use 'disable' or
                      'enable'
                    path: >-
                      /virtual-account/e36ef159-b2d4-4af0-b02c-99dc51798f4b/activation/:status
                400 - Virtual Account doesn't exist.:
                  value:
                    timestamp: '2025-01-07T00:03:14.639+00:00'
                    status: 400
                    error: Bad Request.
                    message: Virtual Account doesn't exist
                    path: >-
                      /virtual-account/e36ef959-12d4-4cf0-b00c-99dc51798f4b2/activation/disable
        '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
      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.