BeneficiaryLookupResource
JSON:API resource carrying the resolved beneficiary account for the user.
Properties
| Field | Type | Description |
|---|---|---|
type* | string | JSON:API resource type. Always `beneficiary_lookup`. |
attributes* | object | Resolved account metadata. |
account_number* | string | Account number the lookup was made with, whether CLABE, card, or DiMo phone. |
account_type* | string | Account type auto-detected at registration. `clabe`: 18-digit CLABE; `card`: 16-digit card; `phone`: 10-digit phone. |
bank_code* | string | SPEI code (5 digits) of the resolved bank. It is the empty string (`""`) for a card whose BIN is not in the directory. |
bank_name* | string | Official name of the bank, resolved from its `bank_code`. |
label | string | null | Free-form label, `null` when none was assigned. |
Used in operations
GET /v1/beneficiaries/lookup