← Volver al índice de esquemas

`UpdateBeneficiaryResponse`

Respuesta de `PUT /v1/beneficiaries/{id}`: el beneficiario actualizado, con los campos derivados ya recalculados.

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 de recurso JSON:API. Siempre `beneficiary`.
`id`*	`string`	Identificador numérico del beneficiario en el sistema.
`attributes`*	`object`	Datos canónicos del beneficiario: los de la cuenta y los del registro.
`account_number`*	`string`	Número de cuenta almacenado: CLABE (18 dígitos), tarjeta (16 dígitos) o celular/DiMo (10 dígitos). Use `account_type` para desambiguar el tipo exacto.
`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 (`""`) cuando la cuenta no tiene un banco conocido: una tarjeta cuyo BIN no está en el directorio. En ese caso `bank_name` trae un texto de relleno en el idioma de la petición.
`bank_name`*	`string`	Nombre oficial del banco, resuelto a partir de su `bank_code`. Con un `bank_code` vacío es un texto de relleno («BIN no reconocido (411111)»), que se traduce al idioma de la petición.
`label`	`string \| null`	Etiqueta descriptiva libre del usuario. `null` cuando no fue asignada.
`status`*	`string`	Estado del beneficiario. `inactive` si el beneficiario fue archivado. `active` si está en uso.
`created_at`*	`string (date-time)`	Fecha y hora, en ISO 8601 UTC, de creación.
`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

PUT /v1/beneficiaries/{id}