Struct UpdateInAddressBookRequest 

pub struct UpdateInAddressBookRequest {

    pub currency: String,
    pub address_type: AddressBookType,
    pub address: String,
    pub label: String,
    pub agreed: bool,
    pub personal: bool,
    pub beneficiary_vasp_name: String,
    pub beneficiary_vasp_did: String,
    pub beneficiary_address: String,
    pub beneficiary_vasp_website: Option<String>,
    pub beneficiary_first_name: Option<String>,
    pub beneficiary_last_name: Option<String>,
    pub beneficiary_company_name: Option<String>,
    pub tag: Option<String>,
}

Request parameters for updating an address in the address book.

Used with the /private/update_in_address_book endpoint. This endpoint allows providing beneficiary information for travel rule compliance.

Fields

currency: String

Currency symbol (e.g., “BTC”, “ETH”, “USDC”)

address_type: AddressBookType

Address book entry type

address: String

Address in proper format for the currency

label: String

User-defined label for the address

agreed: bool

Whether the user agrees to share information with third parties

personal: bool

Whether the address belongs to the user (personal/un-hosted wallet)

beneficiary_vasp_name: String

Name of the beneficiary VASP (Virtual Asset Service Provider)

beneficiary_vasp_did: String

DID (Decentralized Identifier) of the beneficiary VASP

beneficiary_address: String

Geographical address of the beneficiary

beneficiary_vasp_website: Option<String>

Website of the beneficiary VASP (required if VASP not in known list)

beneficiary_first_name: Option<String>

First name of the beneficiary (if a person)

beneficiary_last_name: Option<String>

Last name of the beneficiary (if a person)

beneficiary_company_name: Option<String>

Company name of the beneficiary (if a company)

tag: Option<String>

Tag for XRP addresses (destination tag)

Implementations

impl UpdateInAddressBookRequest

pub fn new( currency: String, address_type: AddressBookType, address: String, label: String, agreed: bool, personal: bool, beneficiary_vasp_name: String, beneficiary_vasp_did: String, beneficiary_address: String, ) -> Self

Creates a new request to update an address in the address book.

Arguments

• currency - Currency symbol (e.g., “BTC”, “ETH”)
• address_type - Type of address book entry
• address - The cryptocurrency address
• label - User-defined label for the address
• agreed - Whether user agrees to share info with third parties
• personal - Whether the address belongs to the user
• beneficiary_vasp_name - Name of the beneficiary VASP
• beneficiary_vasp_did - DID of the beneficiary VASP
• beneficiary_address - Geographical address of the beneficiary

pub fn with_beneficiary_vasp_website(self, website: String) -> Self

Sets the beneficiary VASP website.

pub fn with_beneficiary_first_name(self, first_name: String) -> Self

Sets the beneficiary first name.

pub fn with_beneficiary_last_name(self, last_name: String) -> Self

Sets the beneficiary last name.

pub fn with_beneficiary_company_name(self, company_name: String) -> Self

Sets the beneficiary company name.

pub fn with_tag(self, tag: String) -> Self

Sets the tag for XRP addresses.

Trait Implementations

impl Clone for UpdateInAddressBookRequest

fn clone(&self) -> UpdateInAddressBookRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateInAddressBookRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UpdateInAddressBookRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UpdateInAddressBookRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.