← Volver al índice de esquemas
BinLookupResponse
Respuesta de `GET /v1/public/bin-lookup/{bin}`. Un único recurso con el banco emisor SPEI resuelto contra el catálogo local `bin_directory` (lectura pura, sin consulta externa). Un BIN desconocido devuelve `404`, no este cuerpo.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
data | object | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`). |
type* | string | Tipo del recurso API (`bin_lookup` por defecto). |
id* | string | BIN (6-8 dígitos) que coincidió en la búsqueda. |
attributes* | object | Atributos del BIN y del banco asociado. |
bin* | string | BIN (6-8 dígitos) que coincidió en la búsqueda (mismo valor que `id`). |
bank_name* | string | Nombre oficial de la institución bancaria. |
banxico_code* | string | null | Código de la institución bancaria ante el sistema SPEI (5 dígitos), o `null` cuando el banco no es participante SPEI (ej: Amex). |
card_brand | string | null | Red de la tarjeta (VISA, MASTERCARD, …), o `null` si se desconoce. |
card_type | string | null | Tipo de tarjeta (CREDIT, DEBIT, PREPAID, …), o `null` si se desconoce. |
card_level | string | null | Nivel de la tarjeta (GOLD, PLATINUM, …), o `null` si se desconoce. |
country_iso* | string | Código del país emisor (en ISO-3166 alpha-2). |
meta | object | Metadatos 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. |
version | string | Versión de la API que procesó la petición. |
api_version | string | Versión del prefijo de ruta de la API (ej. `v1`). |
request_id | string | Identificador único de la petición (hex). |
datetime | object | Descriptor 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* | string | Siempre `UTC` — la zona canónica para cada campo datetime del cuerpo. |
format* | string | Siempre `ISO 8601` — sufijo `Z` explícito en cada datetime. |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
Usado en operaciones
GET /v1/public/bin-lookup/{bin}