← Back to schema index

UpdateBeneficiaryRequest

Body for `PUT /v1/beneficiaries/{id}`. Accepts JSON:API envelope `{ data: { attributes: {...} } }` or a flat object. All fields are optional — only those present are updated. If the body contains no editable field the server returns `422 no_valid_fields`. Three update paths: - `label` only: sanitized and persisted. - New `account_number`: re-derives `account_type`, `bank_code` and `bank_name` using the same rules as `POST /v1/beneficiaries`. - `bank_code` only: valid only when the existing beneficiary is of type `phone`; silently ignored for CLABE/card. Triggers the `beneficiary.phone_bank_updated` audit event when the code changes.

Properties

Field Type Description
label string Optional free-form label. Sanitized with `strip_tags` + `trim`.
account_number string New account number. Replaces the existing one and triggers the re-derivation of `account_type`, `bank_code` and `bank_name`. For type `phone`, `bank_code` must accompany the request.
bank_code string 5-digit Banxico SPEI code. For `phone` beneficiaries, may be sent alone to reassign the DiMo receiving bank. For CLABE/card the field is ignored.

Used in operations

  • PUT /v1/beneficiaries/{id}