Pular para o conteúdo principal
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. Use este endpoint para consultar um alias de pagamento antes de enviar um payout. Ele retorna o status do alias e uma visão mascarada do proprietário registrado, para que você possa confirmar que o alias está ativo e corresponde ao destinatário esperado. Esta é uma consulta somente leitura. Ela não cria uma transação e não reserva fundos. Chamar este endpoint é opcional. Você ainda pode enviar um payout diretamente por meio de Enviar fundos por transferência bancária sem verificar o alias antes. Verificá-lo previamente reduz payouts com falha causados por um alias inativo ou não registrado.
Disponível atualmente apenas para a Colômbia. countryISOCode aceita somente CO, e aliasClassification aceita somente Breb (o sistema de pagamento instantâneo Bre-B da Colômbia). O suporte a outros países e classificações de alias poderá ser adicionado no futuro.

Antes de começar

Certifique-se de ter:
  • Credenciais de API válidas (token de acesso).
  • O alias que você deseja verificar, junto com sua classificação.

Endpoint

Os detalhes completos de parâmetros e schemas também estão disponíveis na referência de API Get Alias Detail.

Cabeçalhos obrigatórios

Corpo da requisição

countryISOCode recebe o código de 2 letras (CO), e não o código de 3 letras (COL) usado pela maioria dos outros endpoints da Localpayment. Isso corresponde à API em produção e não deve ser “corrigido” na sua integração.

Exemplo de solicitação

Trate a resposta

Resposta bem-sucedida

Campos da resposta e mascaramento

A Localpayment mascara dados pessoais na resposta. Somente os campos abaixo são retornados, e apenas nesta forma mascarada.

Tratamento de erros

Sempre trate esses casos na sua integração, em vez de presumir que toda consulta será bem-sucedida. Para orientações gerais sobre como interpretar os códigos de status HTTP e a estrutura das respostas de erro na API da Localpayment, consulte Tratamento de erros.

Demonstração

Experimente a consulta com um alias de exemplo para ver como o resultado mascarado é exibido. A demonstração reflete o escopo atual: apenas Colômbia.

Próximos passos

Enviar fundos por transferência bancária

Envie um payout usando o alias que você verificou.

Colômbia

Consulte os bancos, os tipos de documento e os métodos de payout compatíveis com a Colômbia.
Última modificação em 10 de novembro de 2026