← Volver al índice de esquemas
BeneficiaryLookupResource
Recurso JSON:API con la cuenta beneficiaria resuelta para el usuario.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
type* | string | Tipo del recurso JSON:API. Siempre `beneficiary_lookup`. |
attributes* | object | Metadatos de la cuenta resuelta. |
account_number* | string | Número de cuenta consultado. |
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. |
bank_name* | string | Nombre oficial del banco resuelto, derivado de su `bank_code`. |
label | string | null | Etiqueta libre del beneficiario, `null` si no fue asignada. |
Usado en operaciones
GET /v1/beneficiaries/lookup