Update beneficiary

Updates the details of an existing beneficiary. Only profile fields (name, address, city, postal code, country and visibility) can be edited. Bank account details captured at creation (currency/asset type, bank country, IBAN, account numbers, sort/routing codes, BIC/SWIFT and the Currencycloud-specific identifiers) are immutable: they are marked read-only and any value supplied for them is ignored, the stored value is preserved. To change bank details, delete the beneficiary and create a new one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

beneficiaryId

string
required

clientId

string
required

customerId

Body Params

Beneficiary fields to update

Request body for the Update Beneficiary operation. Identical to SaveBeneficiaryViaAPI except that all bank-account detail fields are read-only: they are captured at creation and cannot be modified on update. Any value supplied for a read-only field is ignored and the stored value is preserved.

string

The id of the client

string
enum
Allowed:
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
string
length ≤ 1000
string
length ≤ 100
^[ÑA-Zña-z0-9.\s-]+$

required if type is PERSON

string
length ≤ 100
^[ÑA-Zña-z0-9.\s-]+$

required if type is PERSON

string
length ≤ 60

required if type is COMPANY

boolean
Defaults to true

allows a user to display or not a beneficiary. True by default

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*