← Volver al índice de esquemas
LookupBeneficiaryAccountResponse
Respuesta de `GET /v1/beneficiaries/lookup`: los metadatos del beneficiario cuando la cuenta consultada está entre las del usuario autenticado.
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 JSON:API. Siempre `beneficiary_lookup`. |
attributes* | object | Datos de la cuenta resuelta. |
account_number* | string | Número de cuenta con el que se buscó, ya sea CLABE, tarjeta o celular DiMo. |
account_type* | string | Tipo de cuenta: `clabe` (18 dígitos), `card` (16 dígitos) o `phone` (10 dígitos). |
bank_code* | string | Código SPEI (5 dígitos) del banco resuelto. Es la cadena vacía (`""`) para una tarjeta cuyo BIN no está en el directorio. |
bank_name* | string | Nombre oficial del banco, resuelto a partir de su `bank_code`. |
label | string | null | Etiqueta libre del beneficiario, `null` cuando no fue asignada. |
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/beneficiaries/lookup