Skip to main content
PATCH
Updates the mutable fields of a beneficiary. All request fields are optional; only the fields provided are changed.
beneficiary_type, first_name / middle_name / last_name, company_name, status, and verified are not client-editable. To change identity details, create a new beneficiary; to change status, use the disable action.

​
Path Parameters

​
string
required
Id of the parent account (e.g. acct_...).
​
string
required
Beneficiary id (e.g. bene_...).

​
Request Body

​
string | null
Max 255 characters.
​
string | null
Max 255 characters.
​
string | null
Max 50 characters.
​
Address | null
Replacement address object. If provided, all Address sub-fields are required and country must be ISO 3166-1 alpha-2.
​
PaymentCountry | null
ISO 3166-1 alpha-2 country code on the payment-country allowlist.

​
Response

Returns 200 with the updated beneficiary object.