← Volver al índice de esquemas
ListBeneficiariesResponse
Respuesta de `GET /v1/beneficiaries`. Contiene un arreglo plano (sin paginación) con todas las cuentas beneficiarias del usuario autenticado. El filtro tri-state `?with_archived` controla si se incluyen las cuentas archivadas.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
type * | string | Tipo de recurso JSON:API. Siempre `beneficiary`. |
id * | integer | Identificador numérico autoincremental del beneficiario en la tabla `user_beneficiaries`. |
attributes * | object | Atributos canónicos del beneficiario (datos de la cuenta receptora y metadatos del registro). |
account_number * | string | Número de cuenta almacenado: CLABE (18 dígitos), tarjeta (13-19 dígitos) o celular DiMo (10 dígitos). Use `account_type` para desambiguar el tipo exacto. |
account_type * | string | Tipo de cuenta autodetectado: `clabe` (18 dígitos), `card` (13-19 dígitos) o `phone` (10 dígitos, celular DiMo). |
bank_code * | string | Código Banxico de 5 dígitos del banco receptor, derivado del prefijo CLABE, BIN de la tarjeta o catálogo DiMo. |
bank_name * | string | Nombre del banco resuelto a partir del prefijo CLABE, BIN de la tarjeta o catálogo DiMo. |
label | string | null | Etiqueta descriptiva libre del usuario. `null` si no fue asignada. |
status * | string | Estado del beneficiario. `inactive` se asigna cuando el beneficiario se archiva (no aparece en listados por defecto). |
created_at * | string (date-time) | Marca temporal UTC de creación. |
Variantes
allOf
-
SuccessEnvelope -
object
Usado en operaciones
GET /v1/beneficiaries