Saltar al contenido principal
POST
Obtener detalles del alias
Comprueba si hay un alias de pago activo y consulta los datos del propietario enmascarado antes de enviar un pago. Actualmente disponible solo para Colombia. Consulta la sección Verificar un alias de pago para obtener la referencia completa de los campos de respuesta, las reglas de enmascaramiento, la guía para el manejo de errores y una demostración interactiva.

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

Authorization
string
requerido

Token de acceso Bearer para la autenticación. Este token se obtiene de los endpoints Get Access Token o Refresh Access Token.

Cuerpo

application/json
countryISOCode
enum<string>
requerido

País del alias, en formato ISO 3166-1 alfa-2 (no alfa-3, a diferencia de la mayoría de los demás endpoints de Localpayment). Actualmente solo se admite CO (Colombia).

Opciones disponibles:
CO
aliasClassification
enum<string>
requerido

Clasificación del alias. Actualmente solo se admite Breb (el sistema de pago instantáneo Bre-B de Colombia).

Opciones disponibles:
Breb
aliasValue
string
requerido

El alias a verificar (número de teléfono, documento, correo electrónico, código de comerciante o clave alfanumérica).

Respuesta

OK

firstName
string

Nombre de pila registrado del propietario del alias.

lastName
string

Apellido registrado del propietario del alias. Enmascarado: se muestran las dos primeras letras y el resto se reemplaza con asteriscos (Doe se convierte en Do**).

status
string

Estado actual del alias.

Ejemplo:

"ACTIVE"

idType
string

Tipo de documento de identidad del propietario. Consulta Tipos de documentos admitidos.

idValue
string

El número del documento de identidad del propietario. Enmascarado: solo se muestran los últimos 4 dígitos, el resto se reemplaza con asteriscos (20304050 se convierte en ****4050).

aliasType
string

Clasificación del alias que se resolvió (documento de identidad, código de comerciante, número de teléfono móvil, dirección de correo electrónico o clave alfanumérica). Los valores confirmados en vivo están en mayúsculas, por ejemplo PHONE; la cadena exacta para cada una de las demás categorías aún no está confirmada.

aliasValue
string

El alias que consultó, devuelto completo.

bankName
string

Nombre del banco donde está registrado el alias.

Última modificación el 10 de noviembre de 2026