← Volver al índice de esquemas

BeneficiaryLookupResource

Recurso JSON:API con la cuenta beneficiaria resuelta para el usuario.

Propiedades

CampoTipoDescripción
type*stringTipo del recurso JSON:API. Siempre `beneficiary_lookup`.
attributes*objectDatos de la cuenta resuelta.
account_number*stringNúmero de cuenta con el que se buscó, ya sea CLABE, tarjeta o celular DiMo.
account_type*stringTipo de cuenta: `clabe` (18 dígitos), `card` (16 dígitos) o `phone` (10 dígitos).
bank_code*stringCódigo SPEI (5 dígitos) del banco resuelto. Es la cadena vacía (`""`) para una tarjeta cuyo BIN no está en el directorio.
bank_name*stringNombre oficial del banco, resuelto a partir de su `bank_code`.
labelstring | nullEtiqueta libre del beneficiario, `null` cuando no fue asignada.

Usado en operaciones

  • GET /v1/beneficiaries/lookup

Referenciado por esquemas