Criar um alias para uma Virtual Account
curl --request POST \
--url https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "C",
"value": "alias.example"
}
'import requests
url = "https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias"
payload = {
"type": "C",
"value": "alias.example"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'C', value: 'alias.example'})
};
fetch('https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'C',
'value' => 'alias.example'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias"
payload := strings.NewReader("{\n \"type\": \"C\",\n \"value\": \"alias.example\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"C\",\n \"value\": \"alias.example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"C\",\n \"value\": \"alias.example\"\n}"
response = http.request(request)
puts response.read_body{
"externalId": "94c6faee-0b35-4304-915b-e857981b4c01",
"alias": {
"type": "C",
"value": "alias.example"
},
"status": {
"code": "100",
"description": "INPROGRESS",
"detail": "Alias creation pending confirmation"
}
}
Alias de Virtual Account
Criar um alias para uma Virtual Account
POST
/
api
/
virtual-account
/
{externalId}
/
alias
Criar um alias para uma Virtual Account
curl --request POST \
--url https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "C",
"value": "alias.example"
}
'import requests
url = "https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias"
payload = {
"type": "C",
"value": "alias.example"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'C', value: 'alias.example'})
};
fetch('https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'C',
'value' => 'alias.example'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias"
payload := strings.NewReader("{\n \"type\": \"C\",\n \"value\": \"alias.example\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"C\",\n \"value\": \"alias.example\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stage.localpayment.com/api/virtual-account/{externalId}/alias")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"C\",\n \"value\": \"alias.example\"\n}"
response = http.request(request)
puts response.read_body{
"externalId": "94c6faee-0b35-4304-915b-e857981b4c01",
"alias": {
"type": "C",
"value": "alias.example"
},
"status": {
"code": "100",
"description": "INPROGRESS",
"detail": "Alias creation pending confirmation"
}
}
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
INPROGRESSnão significa que o alias já esteja ativo. Verifique a ativação usando o endpoint Obtenha o status da sua Virtual Account.- Para verificar quais aliases estão ativos no momento em uma Virtual Account, use o endpoint Obtenha o status da sua Virtual Account.
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.
Autorizações
Cabeçalhos
Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso.
Parâmetros de caminho
Corpo
application/json
Última modificação em 10 de novembro de 2026

