← Volver al índice de esquemas
Beneficiary
Cuenta beneficiaria registrada como recurso JSON:API. Puede ser una CLABE, un número de tarjeta o un número de celular DiMo. El tipo de cuenta se autodetecta por longitud al momento de inserción.
ExtiendeJsonApiResourceBase
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
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. |
Usado en operaciones
GET /v1/beneficiariesPOST /v1/beneficiariesPUT /v1/beneficiaries/{id}