Pular para o conteúdo principal
POST
Obter detalhes do alias
Verifique se um alias de pagamento está ativo e confira os detalhes do proprietário mascarado antes de enviar um pagamento. Disponível atualmente apenas para a Colômbia. Consulte a seção Verificar um Alias de Pagamento para obter a referência completa dos campos de resposta, regras de mascaramento, orientações sobre tratamento de erros e uma demonstração interativa.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso.

Corpo

application/json
countryISOCode
enum<string>
obrigatório

País do alias, no formato ISO 3166-1 alpha-2 (não alpha-3, ao contrário da maioria dos outros endpoints da Localpayment). Atualmente, somente CO (Colômbia) é suportado.

Opções disponíveis:
CO
aliasClassification
enum<string>
obrigatório

Classificação do alias. Atualmente, somente Breb (sistema de pagamento instantâneo Bre-B da Colômbia) é suportado.

Opções disponíveis:
Breb
aliasValue
string
obrigatório

O alias para verificação (número de telefone, documento, e-mail, código do comerciante ou chave alfanumérica).

Resposta

OK

firstName
string

Nome registrado do proprietário do alias.

lastName
string

Sobrenome registrado do proprietário do alias. Mascarado: as duas primeiras letras são exibidas e o restante é substituído por asteriscos (Doe torna-se Do**).

status
string

Status atual do alias.

Exemplo:

"ACTIVE"

idType
string

Tipo de documento de identidade do titular. Consulte Tipos de Documentos Suportados.

idValue
string

Número do documento de identidade do proprietário. Mascarado: apenas os últimos 4 dígitos são exibidos e o restante é substituído por asteriscos (20304050 vira ****4050).

aliasType
string

Classificação do alias que foi resolvido (documento de identidade, código de comerciante, número de celular, endereço de e-mail ou chave alfanumérica). Os valores ativos confirmados estão em maiúsculas, por exemplo PHONE; a string exata de cada uma das outras categorias ainda não foi confirmada.

aliasValue
string

O alias que você consultou, retornado por completo.

bankName
string

Nome do banco onde o alias está registrado.

Última modificação em 10 de novembro de 2026