> ## 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/Desativar Virtual Account

O Localpayment permite suspender ou reativar temporariamente contas virtuais, oferecendo flexibilidade para gerenciar o status da conta sem excluí-la permanentemente. Isso é útil para bloqueios temporários, resolução de disputas ou padrões de negócios sazonais.

## Antes de começar

Certifique-se de ter:

* [Credenciais de API](https://docs.localpayment.com/pt-br/docs/api-keys-and-environments.md) válidas (token de acesso).
* ID externo da conta virtual que você deseja ativar ou desativar.
* Compreensão do estado atual da conta virtual.

***

## Gerenciamento do status da conta virtual

Gerencie o status da sua conta virtual usando qualquer um dos seguintes métodos:

> [card] [Ativar conta virtual](#enable-virtual-account)
>
> Ative uma conta virtual previamente desativada para retomar o recebimento de pagamentos.

> [card] [Desativar conta virtual](#disable-virtual-account)
>
> Suspender temporariamente uma conta virtual para impedir pagamentos futuros, preservando os dados da conta.

> [card] [Verificar status da conta](https://docs.localpayment.com/pt-br/docs/get-virtual-account-status.md)
>
> Verifique o status atual de uma conta virtual antes de ativá-la ou desativá-la.

***

## Referência de Status da Virtual Account

Compreender os status das contas virtuais é crucial para o gerenciamento adequado de ativação/desativação:

| Descrição | Pode habilitar | Pode desativar |
| - | - | - |
| INPROGRESS | ❌ | ❌ |
| COMPLETED | ❌ | ✅ |
| DELETED | ❌ | ❌ |
| DISABLED | ✅ | ❌ |

***

## Ativar conta virtual

Reative uma conta virtual previamente desativada para retomar o recebimento de pagamentos.

Envie uma solicitação `PUT` ao endpoint [Atualizar status da Virtual Account](https://docs.localpayment.com/pt-br/reference/update-virtual-account-status.md) usando o ID externo:

### Exemplo de solicitação

Abaixo está um exemplo usando `curl`:

```bash curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
curl --request PUT \
     --url https://api.stage.localpayment.com/api/virtual-account/{externalId}/activation/enable/ \
  --header 'Authorization: Bearer <your_access_token>' \
     --header 'accept: application/json'
```

### Parâmetros-chave da solicitação

A solicitação requer vários objetos-chave:

| Parâmetro | Descrição | Obrigatório |
| - | - | - |
| `externalId` | O ID externo da conta virtual a ser ativada (parâmetro de caminho) | ✅ |

### Resposta bem-sucedida

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "currency": "MXN",
  "externalId": "e36ef929-c2d4-fcf0-b30c-99dc51798f4b",
  "internalId": "c09095fb-6a0e-47af-9f43-3d9452b0f290",
  "accountNumber": "{{accountNumber}}",
  "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": []
}
```

### Campos de resposta principais

| Campo | Descrição | Caso de uso |
| :- | :- | :- |
| `internalId` | Identificador único da Localpayment para a Virtual Account. | Suporte e referência do sistema |
| `externalId` | Seu número de referência original para a virtual account. | Conciliação e rastreamento internos |
| `status.code` | Código de status atual da Virtual Account. | Determine a usabilidade da conta e as próximas ações. |

***

## Desativar conta virtual

Suspender temporariamente uma conta virtual para impedir pagamentos futuros, preservando os dados e o histórico da conta.

Envie uma solicitação `PUT` ao endpoint [Atualizar status da Virtual Account](https://docs.localpayment.com/pt-br/reference/update-virtual-account-status.md) usando o ID externo:

> [!WARNING]
>
> **Importante**
>
> No Peru, quando uma conta virtual é desativada, ela aparecerá como inexistente no seu aplicativo bancário.

### Exemplo de solicitação

Abaixo está um exemplo usando `curl`:

```bash curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
curl --request PUT \
     --url https://api.stage.localpayment.com/api/virtual-account/{externalId}/activation/disable/ \
  --header 'Authorization: Bearer <your_access_token>' \
     --header 'accept: application/json'
```

### Parâmetros-chave da solicitação

A solicitação requer vários objetos-chave:

| Parâmetro | Descrição | Obrigatório |
| - | - | - |
| `externalId` | O ID externo da conta virtual a ser desativada (parâmetro de caminho) | ✅ |

### Resposta bem-sucedida

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "currency": "MXN",
  "externalId": "f059a032-9253-4607-9b8e-2948ed18d595",
  "internalId": "c09095fb-6a4e-17cf-9343-9d9452b0f290",
  "accountNumber": "{{accountNumber}}",
  "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": []
}
```

### Campos de resposta principais

| Campo | Descrição | Caso de uso |
| :- | :- | :- |
| `internalId` | Identificador único da Localpayment para a Virtual Account. | Suporte e referência do sistema |
| `externalId` | Seu número de referência original para a virtual account. | Conciliação e rastreamento internos |
| `status.code` | Código de status atual da Virtual Account. | Determine a usabilidade da conta e as próximas ações. |

***

## Próximos passos

Após gerenciar o status de ativação da conta virtual, talvez seja necessário realizar ações adicionais:

> [card] [Verificar o status da conta virtual](https://docs.localpayment.com/pt-br/docs/get-virtual-account-status.md)
>
> Verifique o status atual das contas virtuais ativadas ou desativadas.

> [card] [Excluir Virtual Account](https://docs.localpayment.com/pt-br/docs/delete-virtual-account.md)
>
> Desative permanentemente uma Virtual Account. Isso impede todos os pagamentos futuros para ela, mas mantém todo o seu histórico. A ação é irreversível. Use para contas que não são mais necessárias; crie uma nova para retomar as operações.


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