← Volver al índice de esquemas

ValidateAccountResponse

Respuesta de `GET /v1/beneficiaries/validate-account?account=`. Resultado estructural de un número de cuenta. Bajo `data.attributes` se reporta el tipo detectado, el checksum, los metadatos del banco resuelto (cuando se puede) y, para CLABEs parciales de 17 dígitos, la versión auto-completada. Este endpoint **no** consulta Banxico — solo validación local.

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
type*stringTipo del recurso JSON:API. Siempre `account_validation`.
attributes*objectResultado de la validación estructural.
input*stringTexto recibido (sin normalizar).
length*integerLongitud en dígitos del input normalizado.
is_numeric*boolean`true` cuando el input original contenía únicamente dígitos (sin separadores).
account_type*stringTipo de cuenta detectado por longitud, o `unknown` para entradas fuera de rango. Los tipos reconocidos son `clabe`, `card` y `phone`.
is_complete*boolean`true` cuando el input está completo para su tipo (18 dígitos en CLABE, 16 en tarjeta, 10 en celular).
checksum_valid*boolean`true` cuando el dígito de control de la CLABE o el Luhn de la tarjeta es válido. Para celular siempre `false` (no aplica).
computed_control_digitstring | nullDígito de control CLABE calculado a partir de los primeros 17 dígitos. `null` cuando el tipo no es CLABE o el cálculo no es aplicable.
auto_completedstring | nullCLABE de 18 dígitos auto-completada cuando el input venía con 17 dígitos y el control pudo calcularse. `null` en los demás casos.
bankobject | nullMetadatos del banco resuelto, o `null` cuando no se pudo identificar. Se deriva del prefijo o BIN.
banxico_codestring | nullCódigo SPEI de 5 dígitos (cuando el banco está mapeado).
namestringNombre oficial del banco resuelto.
cardobject | nullMetadatos adicionales del BIN cuando `account_type=card` y hubo coincidencia en el directorio. `null` en cualquier otro caso.
binstringPrefijo BIN consultado.
brandstring | nullMarca de la tarjeta (Visa, Mastercard, etc.).
typestring | nullTipo de tarjeta (`debit`, `credit`, etc.).
levelstring | nullNivel de la tarjeta (`classic`, `gold`, etc.).
country_isostring | nullISO 3166-1 alpha-2 del país emisor.
metaobjectMetadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
timezone*stringSiempre `UTC` — la zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601` — sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • GET /v1/beneficiaries/validate-account