updatePersonalBeneficiary

Noneditable Fields

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

Parameters

Parameter Type Required
beneficiary_id UUID true
email Email false
phone String false
phone_country String false
first_name String false
last_name String false
date_of_birth DateTime false
address1 String false
address2 String false
city String false
state_province_region String false
postal_code PostalCode false
country ISO3166_1 false
tax_number TaxNumber false
name_on_bank_account String false
swift_bic SwiftBic false
account_type AccountType false
account_number BankAccountNumber false
routing_code BankRoutingCode false
branch_name String false
bank_name String false
bank_address1 String false
bank_address2 String false
bank_city String false
bank_state_province_region String false
bank_postal_code PostalCode false

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
    )
}

Example Code

var axios = require('axios');

var data = JSON.stringify({
  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_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
    ) {
      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_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
      )
    }
  `,
  variables: {
    "beneficiary_id":"2d730dca-8640-42f1-9573-5fe398bdcc92",
    "email":"dj@jeter.com",
    "phone":"",
    "phone_country":"",
    "first_name":"Derek",
    "last_name":"Jeter",
    "date_of_birth":"1940-07-18T00:00:00Z",
    "address1":"2 E 121 St.",
    "address2":"",
    "city":"Bronx",
    "state_province_region":"NY",
    "postal_code":"10451",
    "country":"US",
    "tax_number":"",
    "name_on_bank_account":"Derek",
    "swift_bic":"CITIUS12",
    "account_number":"00000002",
    "routing_code":"113596002",
    "bank_name":"Citibank",
    "branch_name":"",
    "bank_address1":"388 GREENWICH STREET",
    "bank_address2":"",
    "bank_city":"Bronx",
    "bank_state_province_region":"NY",
    "bank_postal_code":"10451",
  }
});

var config = {
  method: 'post',
  url: 'https://sandbox.external.routefusion.com/graphql',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Response Example

{
  "data": {
    "updatePersonalBeneficiary": "2d730dca-8640-42f1-9573-5fe398bdcc92"
  }
}