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 | Numeric identifier of the beneficiary in the system. |
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 | SPEI code (5 digits) of the resolved bank. It is the empty string (`""`) when the account has no known bank: a card whose BIN is not in the directory. In that case `bank_name` carries a placeholder text in the language of the request. |
bank_name* | string | Official name of the bank, resolved from its `bank_code`. With an empty `bank_code` it is a placeholder text ("Unrecognized BIN (411111)"), translated into the language of the request. |
label | string | null | User-assigned descriptive label. `null` when not provided. |
status* | string | Beneficiary status. `inactive` if the beneficiary was archived. `active` if it is in use. |
created_at* | string (date-time) | Date and time, in ISO 8601 UTC, of creation. |
Used in operations
GET /v1/beneficiariesPOST /v1/beneficiariesPUT /v1/beneficiaries/{id}