updateBusinessBeneficiary

The updateBusinessBeneficiary mutation updates the fields on a business 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
business_nameStringfalse
business_address1Stringfalse
business_address2Stringfalse
business_cityStringfalse
business_state_province_regionStringfalse
business_postal_codePostalCodefalse
business_countryISO3166_1false
tax_numberTaxNumberfalse
contact_first_nameStringfalse
contact_last_nameStringfalse
postal_codePostalCodefalse
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 updateBusinessBeneficiary(
    $beneficiary_id: UUID!,
    $email: Email,
    $phone: String,
    $phone_country: String,
    $business_name: String,
    $business_address1: String,
    $business_address2: String,
    $business_city: String,
    $business_state_province_region: String,
    $business_postal_code: PostalCode,
    $business_country: ISO3166_1,
    $tax_number: TaxNumber,
    $contact_first_name: String,
    $contact_last_name: String,
    $postal_code: PostalCode,
    $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
) {
    updateBusinessBeneficiary(
        beneficiary_id: $beneficiary_id,
        email: $email,
        phone: $phone,
        phone_country: $phone_country,
        business_name: $business_name,
        business_address1: $business_address1,
        business_address2: $business_address2,
        business_city: $business_city,
        business_state_province_region: $business_state_province_region,
        business_postal_code: $business_postal_code,
        business_country: $business_country,
        tax_number: $tax_number,
        contact_first_name: $contact_first_name,
        contact_last_name: $contact_last_name,
        postal_code: $postal_code,
        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
    )
}

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