← Volver al índice de esquemas

CreateBeneficiaryResponse

Respuesta de `POST /v1/beneficiaries`. Cuando el endpoint crea un registro nuevo, devuelve `201` con el beneficiario completo en `data`. Cuando el endpoint reactiva una cuenta archivada (mismo `account_number` que un registro `status=inactive`), devuelve `200` con `meta.reactivated=true`.

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

Usado en operaciones

  • POST /v1/beneficiaries