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

# Criar um alias para uma Virtual Account

**Disponibilidade: Argentina**

Esta operação permite que os comerciantes associem um pseudônimo personalizado e legível por humanos (pseudônimo CVU) a uma conta virtual ativa já existente na Argentina.

Um alias substitui a CVU de 22 dígitos por uma sequência de texto curta e fácil de lembrar, reduzindo erros ao compartilhar os detalhes de pagamento.

> **Informações**
>
> * O alias deve ser único em nível de país. Isso não é uma restrição da plataforma, mas uma exigência do sistema bancário argentino. Se outra CVU já usar o mesmo alias, a requisição será rejeitada.
> * Para atualizar um alias, chame este mesmo endpoint com o novo valor depois de decorrido o período de espera obrigatório de 24 horas.
> * Depois de criado ou atualizado, o alias **não pode ser alterado novamente por 24 horas**. Não há limite para o número total de alterações.
> * O alias é ativado de forma assíncrona. Uma resposta `INPROGRESS` não significa que o alias já esteja ativo. Verifique a ativação usando o endpoint [Obtenha o status da sua Virtual Account](https://docs.localpayment.com/pt-br/reference/get-virtual-account-status.md).
> * Para verificar quais aliases estão ativos no momento em uma Virtual Account, use o endpoint [Obtenha o status da sua Virtual Account](https://docs.localpayment.com/pt-br/reference/get-virtual-account-status.md).

## Regras de formatação de alias

* Apenas letras (a–z, A–Z), números (0–9) e pontos (`.`) são permitidos.
* Espaços, hífens, sublinhados, arrobas (`@`) e outros caracteres especiais **não** são permitidos.
* O comprimento deve estar entre **5 e 20 caracteres**.
* Exemplos válidos: `alias.example`, `alias.example2026`, `alias.example.test`

## Melhores práticas

* Utilize aliases significativos e consistentes para auxiliar na reconciliação interna e nos fluxos de suporte.
* Registre as respostas de criação de aliases e associe-as aos seus registros de transações internas para facilitar a auditoria.
* Utilize o endpoint de verificação de status periodicamente ou antes da cobrança do pagamento para verificar se o alias está ativo e mapeado corretamente.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/virtual-account/{externalId}/alias
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}/alias:
    post:
      summary: Criar um alias para uma Virtual Account
      operationId: create-an-alias-to-a-virtual-account
      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: >-
            O identificador único da conta virtual à qual você deseja adicionar
            um alias. Este deve ser exatamente o mesmo valor de externalId
            fornecido ao criar a conta virtual.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - C
                  description: >-
                    Tipo de alias. Para a Argentina, o único valor válido é `C`
                    (Personalizável — texto definido pelo usuário).
                value:
                  type: string
                  description: >-
                    O valor de alias desejado. Somente letras (a–z, A–Z),
                    números (0–9) e pontos (`.`) são permitidos. Deve ter entre
                    5 e 20 caracteres. Deve ser único em toda a plataforma.
                    Exemplo: `alias.example`, `alias.example2026`.
                  minLength: 5
                  maxLength: 20
              required:
                - type
                - value
              x-examples:
                Argentina Example:
                  type: C
                  value: alias.example
            examples:
              Argentina Example:
                value:
                  type: C
                  value: alias.example
      responses:
        '201':
          description: Criado
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: >-
                      O identificador único da conta virtual. Este é o mesmo
                      externalId que você forneceu na solicitação, confirmando
                      que o alias foi criado para a conta correta.
                  alias:
                    type: object
                    description: Informações do alias.
                    properties:
                      type:
                        type: string
                        description: >-
                          Tipo de alias da solicitação (`C` para
                          Personalizável).
                      value:
                        type: string
                        description: O valor do alias da requisição.
                  status:
                    type: object
                    description: Informações de status.
                    properties:
                      code:
                        type: string
                        description: Código de status.
                      description:
                        type: string
                        description: Descrição do status.
                      detail:
                        type: string
                        description: Informações adicionais sobre a resposta.
                x-examples: {}
              examples:
                Argentina Example:
                  value:
                    externalId: 94c6faee-0b35-4304-915b-e857981b4c01
                    alias:
                      type: C
                      value: alias.example
                    status:
                      code: '100'
                      description: INPROGRESS
                      detail: Alias creation pending confirmation
        '400':
          description: Solicitação inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: >-
                      O identificador único da conta virtual. Este é o mesmo
                      externalId que você forneceu na solicitação, confirmando
                      que o alias foi criado para a conta correta.
                  alias:
                    type: object
                    description: Informações do alias.
                    properties:
                      type:
                        type: string
                        description: >-
                          Tipo de alias da solicitação (`C` para
                          Personalizável).
                      value:
                        type: string
                        description: O valor do alias da requisição.
                  status:
                    type: object
                    description: Informações de status.
                    properties:
                      code:
                        type: string
                        description: Código de status.
                      description:
                        type: string
                        description: Descrição do status.
                      detail:
                        type: string
                        description: Informações adicionais sobre a resposta.
                x-examples: {}
              examples:
                776 - Alias already in use:
                  value:
                    externalId: 94c6faee-0b35-4304-915b-e857981b4c01
                    alias:
                      type: C
                      value: alias.example
                    status:
                      code: '776'
                      description: REJECTED
                      detail: >-
                        The alias is already in use; please select a different
                        alias.
                777 - Invalid alias:
                  value:
                    externalId: 94c6faee-0b35-4304-915b-e857981b4c01
                    alias:
                      type: C
                      value: alias.example
                    status:
                      code: '777'
                      description: REJECTED
                      detail: The alias is invalid; please enter a valid alias.
                778 - Change period not elapsed:
                  value:
                    externalId: 94c6faee-0b35-4304-915b-e857981b4c01
                    alias:
                      type: C
                      value: alias.example
                    status:
                      code: '778'
                      description: REJECTED
                      detail: >-
                        The alias cannot be changed now; you must wait 24 hours
                        after the last update.
                779 - System error:
                  value:
                    externalId: 94c6faee-0b35-4304-915b-e857981b4c01
                    alias:
                      type: C
                      value: alias.example
                    status:
                      code: '779'
                      description: REJECTED
                      detail: System error to generate alias
                896 - Alias already assigned:
                  value:
                    externalId: 94c6faee-0b35-4304-915b-e857981b4c01
                    alias:
                      type: C
                      value: alias.example
                    status:
                      code: '896'
                      description: REJECTED
                      detail: Alias already assigned to this virtual account
        '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: {}
              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
        '500':
          description: Erro do Servidor Interno
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: Momento em que a solicitação foi criada.
                  status:
                    type: integer
                    description: Código de status.
                  error:
                    type: string
                    description: Descrição do erro.
                  message:
                    type: string
                    description: Mensagem com informações adicionais.
                  path:
                    type: string
                    description: Caminho da API.
                x-examples: {}
              examples:
                500-Virtual Account doesn't exist:
                  value:
                    timestamp: '2025-05-10T02:14:00.736+00:00'
                    status: 500
                    error: Internal Server Error
                    message: Virtual Account doesn't exist
                    path: /virtual-account/94b6faee-0b875-4304-915b-ei579y1c07/alias
      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.