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 | Queried account number (CLABE, card, or 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 | 5-digit Banxico SPEI code of the receiving bank. |
bank_name* | string | Resolved bank name. |
label | string | null | Free-form label, `null` if none was assigned. |
Used in operations
GET /v1/beneficiaries/lookup