← Back to schema index

UpdateBeneficiaryResponse

Response from `PUT /v1/beneficiaries/{id}` with the updated beneficiary.

Properties

Field Type Description
type * string JSON:API resource type. Always `beneficiary`.
id * integer 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, 13-19 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` (13-19 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).
created_at * string (date-time) UTC creation timestamp.

Variants

allOf

Used in operations

  • PUT /v1/beneficiaries/{id}