Beneficiary
Registered beneficiary account as a JSON:API resource. Can be a CLABE, a card number, or a DiMo phone number. The account type is auto-detected by length at insertion time.
ExtendsJsonApiResourceBase
Properties
| Field | Type | Description |
|---|---|---|
type* | string | JSON:API resource type. Always `beneficiary`. |
id* | string | Auto-increment numeric identifier of the beneficiary in the `user_beneficiaries` table. |
attributes* | object | Canonical beneficiary attributes (recipient account data and record metadata). |
account_number* | string | Stored account number: 18-digit CLABE, 16-digit card, or 10-digit DiMo phone. Use `account_type` to disambiguate the exact type. |
account_type* | string | Auto-detected account type: `clabe` (18 digits), `card` (16 digits), or `phone` (10 digits, DiMo mobile). |
bank_code* | string | 5-digit Banxico code of the receiving bank, derived from the CLABE prefix, card BIN, or DiMo catalog. |
bank_name* | string | Bank name resolved from the CLABE prefix, card BIN, or DiMo catalog. |
label | string | null | User-assigned descriptive label. `null` if not provided. |
status* | string | Beneficiary status. `inactive` is set when the beneficiary is archived (excluded from default listings). `active` — in use; `inactive` — retired without being deleted. |
created_at* | string (date-time) | UTC creation timestamp. |
Used in operations
GET /v1/beneficiariesPOST /v1/beneficiariesPUT /v1/beneficiaries/{id}