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

# Obtenha o status da sua Virtual Account.

Este guia descreve as diferentes abordagens para rastrear o status de Virtual Accounts e gerenciar o ciclo de vida da conta.

O Localpayment oferece diversos métodos para monitorar e obter o status atual de Virtual Accounts, incluindo verificações de contas individuais, status de processamento em lote e visualização no Business Portal.

## Disponibilidade

O monitoramento do status de Virtual Account está disponível em todos os países onde as Virtual Accounts são suportadas:

| País | Métodos suportados |
| - | - |
| **[Argentina](https://docs.localpayment.com/pt-br/docs/argentina.md)** | API individual, API em lote, Business Portal |
| **[Brasil](https://docs.localpayment.com/pt-br/docs/brazil.md)** | API individual, API em lote, Business Portal |
| **[Chile](https://docs.localpayment.com/pt-br/docs/chile.md)** | API individual, API em lote, Business Portal |
| **[Colômbia](https://docs.localpayment.com/pt-br/docs/colombia.md)** | API individual, API em lote, Business Portal |
| **[Costa Rica (CRC & USD)](https://docs.localpayment.com/pt-br/docs/costa-rica.md)** | API individual, API em lote, Business Portal |
| **[México](https://docs.localpayment.com/pt-br/docs/mexico.md)** | API individual, API em lote, Business Portal |
| **[Peru](https://docs.localpayment.com/pt-br/docs/peru.md)** | API individual, Business Portal |

***

## 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).
* IDs de Virtual Accounts ou números de referência de lote que você deseja verificar.

***

## Referência de Status da Virtual Account

As Virtual Accounts podem ter os seguintes status ao longo de seu ciclo de vida:

| Status | Código de status | Descrição |
| - | - | - |
| **INPROGRESS** | `100` | Criação de Virtual Account em andamento |
| **COMPLETED** | `200` | Virtual Account ativa e pronta para pagamentos. |
| **DISABLED** | `300` | A Virtual Account foi temporariamente desativada e não pode ser usada para transações. |
| **DELETED** | `908` | A Virtual Account foi excluída permanentemente. |

> [!NOTE]
>
> Os códigos de status não são exclusivos dos status de Virtual Account. Por exemplo, o código `300` também aparece com a descrição `REJECTED` no endpoint [Criar uma Virtual Account](https://docs.localpayment.com/pt-br/docs/create-a-virtual-account.md) quando uma solicitação falha na validação. Sempre leia `status.code` junto com `status.description` em vez de depender apenas do código.

***

## Recuperar informações da Virtual Account

Após solicitar sua Virtual Account, você poderá verificar o status dela usando qualquer um dos seguintes métodos:

> [card] [Verifique o status da sua Virtual Account individual](#method-1-check-individual-virtual-account-status)
>
> Recupere o status atual e os detalhes de uma Virtual Account específica usando o endpoint da API com o ID externo.

> [card] [Verificar o status da Virtual Account em lote](#method-2-check-batch-virtual-account-status)
>
> Monitore o status das Virtual Accounts criadas em operações em lote, incluindo o progresso da criação e quaisquer erros.

> [card] [Consulte o status da sua Virtual Account pelo portal da empresa.](#method-3-check-virtual-account-status-via-business-portal)
>
> Utilize a interface visual do Business Portal para monitoramento manual, filtragem e operações em massa em Virtual Accounts.

***

## Método 1: Verificar o status da Virtual Account individual

Recupere o status atual e os detalhes de uma Virtual Account específica usando o endpoint de status individual.

### Exemplo de solicitação

Envie uma requisição `GET` para o endpoint [Get Virtual Account Status](https://docs.localpayment.com/pt-br/reference/get-virtual-account-status.md). Abaixo está um exemplo usando `curl`:

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

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

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

| Objeto | Descrição | Obrigatório |
| - | - | - |
| `externalId` | O ID externo usado ao criar a Virtual Account. | ✅ |

### 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": "9a8db65f-be31-42fb-8ebd-5fffd83bd6c6",
  "accountNumber": "{{accountNumber}}",
  "beneficiary": {
    "type": "INDIVIDUAL",
    "name": "Alejandra",
    "lastName": "Guzman",
    "fullName": "Alejandra Guzman",
    "document": {
      "type": "RFC",
      "id": "KCWV771228TS4"
    },
    "address": {
      "street": "Avenida Reforma",
      "number": "500",
      "city": "Ciudad de Mexico",
      "state": "CDMX",
      "country": "Mexico"
    }
  },
  "status": {
    "code": "100",
    "description": "INPROGRESS",
    "detail": "Virtual account in progress"
  },
  "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. |

***

## Método 2: Verificar o status da Virtual Account em lote

Monitore o status das Virtual Accounts criadas em operações em lote, incluindo o progresso da criação e quaisquer erros.

### Exemplo de solicitação

Envie uma requisição `GET` para o endpoint [Get Virtual Account Status (Batch)](https://docs.localpayment.com/pt-br/reference/get-virtual-account-status-batch.md). Abaixo está um exemplo usando `curl`:

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

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

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

| Objeto | Descrição | Obrigatório |
| - | - | - |
| `externalId` | Número de referência do lote. | ✅ |

### Resposta bem-sucedida

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "externalId": "ba671d03-b3bc-4312-8841-5c65a67713ca",
  "internalId": "91c0de90-9d70-44a6-b9c6-600f835802b6",
  "accountNumber": "{{accountNumber}}",
  "status": {
    "code": "200",
    "description": "COMPLETED",
    "detail": "Batch Process Virtual Account completed"
  },
  "comment": "The batch process is done - The process started at = 2025-01-03 22:59:14.355 - Total accounts requested = 12 - Total accounts created = 12 - The process finished at = 2025-01-03 22:59:17.716 - ",
  "csvFormatResponse": "internal_id,external_id,bank_account\ne68208a1-3197-4b1e-82f6-76525a734e56,1111111111-1,646011319800023500\n80dcc234-1010-427b-b256-3fff18325baf,1111111111-2,646011319800023501\nd779c2ab-2505-43b8-874c-fcb97a2e5fb7,1111111111-3,646011319800023502\nafd67163-fd79-4b2c-b288-c4d253bcec57,1111111111-4,646011319800023503\n01e1d1bb-c89c-4d41-849d-bd1d8e5c3785,1111111111-5,646011319800023504\n0ba88114-ae62-407b-9f03-8f863000c163,1111111111-6,646011319800023505\n0184a17a-5c38-4c43-b10a-15079662e518,1111111111-7,646011319800023506\nb80991f5-396d-485a-b480-fdfb8635bef3,1111111111-8,646011319800023507\ncd0f6180-c3ad-4a69-815f-25d6f053aee2,1111111111-9,646011319800023608\n95ea6157-2d17-459c-969a-708ca31cfc13,1111111111-10,646011319800023609\ncf50e4d2-ac34-48f4-a60f-b2ee8b152f6a,1111111111-11,646011319800023610\n70d1f0be-3db0-48fd-8493-b712038ea48e,1111111111-12,646011319800023611\n"
}
```

### 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 operação em lote. | Conciliação e rastreamento internos |
| `status.code` | Código de status atual do processo em lote. | Determine a usabilidade da conta e as próximas ações. |

***

## Método 3: Verificar o status da Virtual Account pelo portal da empresa

Para monitoramento manual e análise visual, utilize o Business Portal da Localpayment para visualizar o status da Virtual Account.

### Acesso ao Business Portal

1. Faça login no seu [Business Portal Localpayment](https://docs.localpayment.com/pt-br/docs/dashboard-overview.md).
2. Acesse a seção **PayIn > Virtual Accounts > Activity**
3. Utilize filtros para pesquisar por:
   * **País**: Escolha um país específico ou selecione **Todos** para incluir todos os países disponíveis.
   * **Status**: Filtre as contas pelo status atual ou selecione **Todas** para visualizar as contas com qualquer status.
   * **Intervalo de datas**: Especifique o intervalo de datas em que as Virtual Accounts foram criadas. Isso filtra a lista com base na data de criação, não na data de atividade.
   * **Virtual Account Number**: Você pode pesquisar diretamente pelo Virtual Account Number (VAN) para localizar rapidamente uma entrada específica.

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/a0ed234f6b684112d81534a8f7e0bb5d20357447839c6adaa5d32dc9f143e186-Virtual-accounts-dashboard.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=27037dee9583061edbc70bee04f7bf40)

***

## Próximos passos

Após monitorar o status da Virtual Account, talvez seja necessário executar ações de gerenciamento adicionais:

> [card] [Instruções de pagamento](https://docs.localpayment.com/pt-br/docs/payment-instructions.md)
>
> Forneça aos pagadores os dados corretos do beneficiário retornados na resposta da API Get Virtual Account Status para processar pagamentos sem problemas. Consulte as instruções específicas de cada país para garantir a execução precisa e em conformidade com as normas.

> [card] [Ativar/Desativar Virtual Account](https://docs.localpayment.com/pt-br/docs/activate-deactivate-virtual-account.md)
>
> Suspenda ou reative temporariamente Virtual Accounts de acordo com as
> necessidades da empresa ou solicitações dos clientes.

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