← Volver al índice de esquemas

`ListBanksResponse`

Respuesta de `GET /v1/public/banks`. Catálogo completo (~95 instituciones) de participantes SPEI activos. Cacheable con ETag — el snapshot cambia semanalmente cuando el sincronizador de Banxico refresca el catálogo.

Propiedades

Campo	Tipo	Descripción
`data`	`array`	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 (`bank` por defecto).
`id`*	`string`	Código bancario de la institución (5 dígitos).
`attributes`*	`object`	Atributos de la institución bancaria.
`code`*	`string`	Código bancario de la institución (5 dígitos). Mismo valor que `id`.
`name`*	`string`	Nombre oficial de la institución bancaria.
`aliases`	`array`	Nombres alternativos (marca/abreviaturas) de la institución bancaria.
`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/banks