updateBusinessBeneficiary
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
| Parameter | Type | Required |
|---|---|---|
| beneficiary_id | UUID | true |
| false | ||
| phone | String | false |
| phone_country | String | false |
| business_name | String | false |
| business_address1 | String | false |
| business_address2 | String | false |
| business_city | String | false |
| business_state_province_region | String | false |
| business_postal_code | PostalCode | false |
| business_country | ISO3166_1 | false |
| tax_number | TaxNumber | false |
| contact_first_name | String | false |
| contact_last_name | String | false |
| postal_code | PostalCode | 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 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
)
}
Example NodeShell Code
var axios = require('axios');
var data = JSON.stringify({
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
)
}`,
variables: {
"beneficiary_id":"2d730dca-8640-42f1-9573-5fe398bdcc92",
"email":"dj@jeter.com",
"phone":"",
"phone_country":"",
"business_name":"Business name",
"business_address1":"2 E 121 St.",
"business_address2":"1940-07-18T00:00:00Z",
"business_city":"NY",
"business_state_province_region":"Bronx",
"business_postal_code":"10451",
"business_country":"US",
"tax_number":"",
"contact_first_name":"",
"contact_last_name":"",
"postal_code":"10451",
"name_on_bank_account":"",
"swift_bic":"CITIUS12",
"account_type":"checking",
"account_number":"00000002",
"routing_code":"113596002",
"branch_name":"",
"bank_name":"Citibank",
"bank_address1":"388 GREENWICH STREET",
"bank_address2":"",
"bank_city":"NY",
"bank_state_province_region":"Bronx",
"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": {
"updateBusinessBeneficiary": "2d730dca-8640-42f1-9573-5fe398bdcc92"
}
}