← Volver al índice de esquemas
CreateBeneficiaryRequest
Cuerpo de `POST /v1/beneficiaries`. Acepta dos formas: un objeto plano con los atributos en la raíz, o el envoltorio JSON:API `{ data: { attributes: {...} } }`. El servidor prueba primero `data.attributes` y, si está ausente, toma el objeto raíz. El tipo de cuenta (`clabe`, `card`, `phone`) se autodetecta por la longitud de los dígitos: 18 = CLABE, 16 = tarjeta, 10 = celular (DiMo). Cuando el tipo detectado es `phone`, `bank_code` es **obligatorio**; para CLABE y tarjeta el `bank_code` enviado por el cliente se ignora y se deriva del prefijo CLABE o del BIN.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
account_number* | string | Número de cuenta. Se aceptan: CLABE (18 dígitos), tarjeta (16 dígitos) o celular/DiMo (10 dígitos). Los separadores, espacios y guiones se eliminan. |
bank_code | string | Código SPEI de 5 dígitos. **Obligatorio cuando el tipo detectado es** `phone`; ignorado para CLABE y tarjeta. |
label | string | Etiqueta opcional libre. |
Usado en operaciones
POST /v1/beneficiaries