# Ativar ou desativar uma conta bancária

Atualiza se uma conta bancária está ativa definindo active como true ou false.

Definir active como false desativa a conta bancária identificada no caminho. Contas desativadas são ignoradas para verificações de duplicidade na mesma instituição, agência e número de conta, o que permite registrar uma nova conta bancária com os mesmos dados bancários quando for necessário corrigir informações incorretas do titular (como nome ou CPF/CNPJ) ou erros semelhantes de um registro inicial.

Endpoint: PATCH /payments/br/bank-accounts/{id}/
Version: 1.223.0
Security: basicAuth

## Header parameters:

  - `X-Belvo-API-Resource-Version` (string)
    Cabeçalho indicando qual versão da API de Pagamentos você deseja usar. Atualmente, isso é aplicável apenas para Contas Bancárias, Clientes e Autorizações de Pagamento no Brasil. No caso de você estar usando nosso produto de Autorizações de Pagamento, então você deve enviar este cabeçalho configurado para Payments-BR.V2.

{% admonition type="warning" name="Em Breve" %}
  Esta versão está em breve lançamento. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
{% /admonition %}
    Enum: "Payments-BR.V2"

## Path parameters:

  - `id` (string, required)
    O bank-account.id que você deseja ativar ou desativar.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

## Request fields (application/json):

  - `active` (boolean, required)
    Quando definido como false, desativa esta conta bancária. Uma conta desativada não conta mais para a exclusividade na mesma instituição, agência e número de conta, permitindo que você registre uma nova conta bancária com os mesmos dados bancários (por exemplo, após corrigir o nome do titular, CPF/CNPJ ou outros metadados).

Quando definido como true, reativa uma conta bancária previamente desativada.

## Response 200 fields (application/json):

  - `body` (object) — one of:
    - V2 - Conta Bancária:
      - `id` (string, required)
        Identificador único da Belvo para o item atual.
        Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
      - `created_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `updated_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi atualizado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `active` (boolean, required)
        Indica se a conta bancária está ativa (e pode ser usada para receber fundos).
        Example: true
      - `holder` (object, required)
        Detalhes do titular da conta.
      - `holder.name` (string, required)
        O nome completo ou razão social do titular da conta.
        Example: "Frangos Enlatados"
      - `holder.identifier` (string, required)
        O CPF (11 dígitos) ou CNPJ (14 dígitos) do titular da conta.
        Example: "12345678901122"
      - `details` (object, required)
        Detalhes da conta bancária.
      - `details.institution` (string, required)
        O ID Belvo da instituição financeira.
        Example: "f512d996-583a-4a91-8b5b-eba2e103b068"
      - `details.account_type` (string, required)
        O tipo de conta bancária. Pode ser:
  - CHECKINGS (também conhecida como Conta Corrente no Brasil)
  - SAVINGS (também conhecida como Conta Poupança no Brasil)
  - PAYMENTS (também conhecida como Conta de Pagamento Instantâneo ou Conta de Pagamento no Brasil)
        Enum: "CHECKINGS", "SAVINGS", "PAYMENTS"
      - `details.agency` (string, required)
        A agência (número da filial) da instituição onde a conta foi criada.
        Example: "0444"
      - `details.number` (string, required)
        O número da conta bancária.

{% admonition type="info" name="Caracteres válidos para número de conta" %}
  Você pode enviar apenas números (^[0-9]+$) na string. Por exemplo, "457220" é um número de conta bancária válido, enquanto "45722-0" é inválido, pois contém um hífen (-).
{% /admonition %}
        Example: "457220"
      - `external_id` (string, required)
        Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
        Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"
      - `metadata` (object, required)
        Objeto opcional e personalizável onde você pode fornecer quaisquer pares de chave-valor adicionais para seus propósitos internos. Por exemplo, um número de referência interno para a intenção de pagamento.

{% admonition type="info" name="Limitações de Metadata" %}
  Você pode fornecer até 50 chaves (as chaves podem ter até 50 caracteres cada e cada valor pode ter até 500 caracteres). Não suportamos objetos aninhados, apenas valores ASCII.
{% /admonition %}
        Example: {"internal_reference_id":"GGq73487w2"}
    - V1 - Conta Bancária (Sem Cabeçalho de Requisição):
      - `id` (string, required)
        Identificador único da Belvo para o item atual.
        Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
      - `created_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `created_by` (string, required)
        O ID único para o usuário que criou este item.
        Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"
      - `customer` (string,null, required)
        ID único da Belvo para o cliente associado à conta bancária.

Para contas bancárias do tipo BUSINESS, este campo é null.
      - `external_id` (string)
        Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
        Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"
      - `institution` (string,null, required)
        ID exclusivo do Belvo para a instituição em que a conta bancária é criada.

Para contas bancárias do tipo BUSINESS que o Belvo cria para organizações, este campo é definido como null.
      - `details` (object, required)
        Informações sobre a conta bancária.
      - `details.account_type` (string, required)
        O tipo de conta bancária. Pode ser:

  - CHECKINGS (também conhecida como Conta Corrente no Brasil)
  - SAVINGS (também conhecida como Conta Poupança no Brasil)
  - SALARY (também conhecida como Conta Salário no Brasil)
  - PAYMENTS (também conhecida como Conta de Pagamento Instantâneo ou Conta de Pagamento no Brasil)
        Enum: "CHECKINGS", "SAVINGS", "SALARY", "PAYMENTS"
      - `details.agency` (string, required)
        A agência (número da filial) da instituição onde a conta foi criada.
        Example: "0444"
      - `details.number` (string, required)
        O número da conta bancária.

> 📘 Caracteres válidos para número de conta
>
> Você pode enviar apenas números (^[0-9]+$) na string. Por exemplo, "457220" é um número de conta bancária válido, enquanto "45722-0" é inválido, pois contém um hífen (-).
        Example: "457220"
      - `holder` (any, required) — one of:
        - OFPI Brasil 🇧🇷 INDIVIDUAL:
          - `type` (string, required)
            O tipo de conta bancária. Para indivíduos, isso deve ser definido como INDIVIDUAL.
            Enum: "INDIVIDUAL"
          - `information` (object, required)
            Detalhes sobre o titular da conta bancária individual.
          - `information.first_name` (string, required)
            O primeiro nome do titular da conta bancária.
            Example: "Dom"
          - `information.last_name` (string, required)
            O sobrenome do titular da conta bancária.
            Example: "Mesa"
          - `information.identifier_type` (string, required)
            O tipo de documento de identificação do cliente. Para indivíduos no Brasil, isso deve ser definido como CPF.
            Enum: "CPF"
          - `information.identifier` (string, required)
            O número do documento da identidade do cliente.
            Example: 191
        - OFPI Brazil 🇧🇷 NEGÓCIOS:
          - `type` (string, required)
            O tipo de conta bancária. Para empresas, isso deve ser definido como BUSINESS.
            Enum: "BUSINESS"
          - `information` (object, required)
            Detalhes sobre o titular da conta bancária individual.
          - `information.name` (string, required)
            O primeiro nome do titular da conta bancária.
            Example: "Gustavo Veloso Entertainment Universe"
          - `information.identifier_type` (string, required)
            O tipo de documento de identificação do cliente. Para empresas no Brasil, isso deve ser definido como CNPJ.
            Enum: "CNPJ"
          - `information.identifier` (string, required)
            O número do documento CNPJ.
            Example: 191

## Response 400 fields (application/json):

  - `code` (string, required)
    Um código de erro único (null, does_not_exist, required, already_registered, invalid_choice, max_length, min_length, blank, null, cancellation_error, idempotency_key_invalid) que permite classificar e tratar o erro de forma programática.
    Example: "required"

  - `message` (string, required)
    Uma breve descrição do erro.

A descrição pode ser (entre outras):

  - Este campo é obrigatório.
  - Objeto com nome=narnia não existe.
  - Este campo não pode ser nulo.
  - Este campo não pode estar em branco.
  - Este cliente já está registrado.
  - Certifique-se de que este campo tenha pelo menos 2 caracteres.
  - Certifique-se de que este campo não tenha mais de 4 caracteres.
  - O valor inserido não é válido.
  - Você deve definir todos os campos obrigatórios: username, password, username_type.
  - Payment Intent não pode ser cancelado porque não está SCHEDULED.
  - Payment Intent não pode ser cancelado pois o horário limite (23:59:00) já passou.
  - A chave de idempotência fornecida é inválida.
    Example: "This field is required."

  - `request_id` (string, required)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `field` (string,null)
    Nome do campo onde o erro foi encontrado.

> Nota: Este campo só está presente quando o erro está relacionado a um campo específico.
    Example: "institution"

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único (not_found) que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"