updatePersonalBeneficiary

The updatePersonalBeneficiary mutation updates the fields on a personal beneficiary that was previously created.

Noneditable Fields

The following beneficiary fields and related resources are not editable and cannot be updated after initial creation:

  • type
  • bank_country
  • currency
  • creator
  • entity

Parameters

ParameterTypeRequired
beneficiary_idUUIDtrue
emailEmailfalse
phoneStringfalse
phone_countryStringfalse
first_nameStringfalse
last_nameStringfalse
date_of_birthDateTimefalse
address1Stringfalse
address2Stringfalse
cityStringfalse
state_province_regionStringfalse
postal_codePostalCodefalse
countryISO3166_1false
tax_numberTaxNumberfalse
name_on_bank_accountStringfalse
swift_bicSwiftBicfalse
account_typeAccountTypefalse
account_numberBankAccountNumberfalse
routing_codeBankRoutingCodefalse
branch_nameStringfalse
bank_nameStringfalse
bank_address1Stringfalse
bank_address2Stringfalse
bank_cityStringfalse
bank_state_province_regionStringfalse
bank_postal_codePostalCodefalse

GraphQL Query

mutation updatePersonalBeneficiary(
    $beneficiary_id: UUID!,
    $email: Email,
    $phone: String,
    $phone_country: String,
    $first_name: String,
    $last_name: String,
    $date_of_birth: DateTime,
    $address1: String,
    $address2: String,
    $city: String,
    $state_province_region: String,
    $postal_code: PostalCode,
    $country: ISO3166_1,
    $tax_number: TaxNumber,
    $name_on_bank_account: String,
    $swift_bic: SwiftBic,
    $account_type: AccountType,
    $account_number: BankAccountNumber,
    $routing_code: BankRoutingCode,
    $branch_name: String,
    $bank_name: String,
    $bank_address1: String,
    $bank_address2: String,
    $bank_city: String,
    $bank_state_province_region: String,
    $bank_postal_code: PostalCode,
    $bank_country: ISO3166_1
) {
    updatePersonalBeneficiary(
        beneficiary_id: $beneficiary_id,
        email: $email,
        phone: $phone,
        phone_country: $phone_country,
        first_name: $first_name,
        last_name: $last_name,
        date_of_birth: $date_of_birth,
        address1: $address1,
        address2: $address2,
        city: $city,
        state_province_region: $state_province_region,
        postal_code: $postal_code,
        country: $country,
        tax_number: $tax_number,
        name_on_bank_account: $name_on_bank_account,
        swift_bic: $swift_bic,
        account_type: $account_type,
        account_number: $account_number,
        routing_code: $routing_code,
        branch_name: $branch_name,
        bank_name: $bank_name,
        bank_address1: $bank_address1,
        bank_address2: $bank_address2,
        bank_city: $bank_city,
        bank_state_province_region: $bank_state_province_region,
        bank_postal_code: $bank_postal_code,
        bank_country: $bank_country
    )
}

Language
Click Try It! to start a request and see the response here!