createBusinessBeneficiary

Note

routing_code in Routefusion is a high level code for the in countries local routing number. Example: In the UK their local routing_code would be a "Sort Code". You can see a map of this here Coverage

Noneditable Fields

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

Parameters

Parameter Type Required
user_id String true
entity_id String true
email String true
phone String false
phone_country String false
business_name String true
business_address1 String false
business_address2 String false
business_city String false
business_state_province_region String false
business_postal_code String false
business_country String true
tax_number String false
name_on_bank_account String false
swift_bic String false
account_type String true
account_number String true
routing_code String false
currency String true
bank_name String false
branch_name String false
bank_address1 String false
bank_address2 String false
bank_city String false
bank_state_province_region String false
bank_postal_code String false
bank_country String true

GraphQL Query

GraphQL

mutation createBusinessBeneficiary (
    $user_id: UUID!
    $entity_id: UUID!
    $email: Email!
    $phone: String
    $business_address1: String
    $business_address2: String
    $business_city: String
    $business_state_province_region: String
    $business_postal_code: PostalCode
    $tax_number: TaxNumber
    $name_on_bank_account: String
    $swift_bic: SwiftBic
    $account_number: BankAccountNumber
    $routing_code: BankRoutingCode
    $currency: ISO4217!
    $bank_name: String
    $branch_name: String
    $bank_address1: String
    $bank_address2: String
    $bank_city: String
    $bank_state_province_region: String
    $bank_postal_code: PostalCode
    $bank_country: ISO3166_1!,
    $business_name: String!,
    $business_country: ISO3166_1!
) {
    createBusinessBeneficiary (
        user_id: $user_id
        entity_id: $entity_id
        email: $email
        phone: $phone
        business_name: $business_name,
        business_address1: $address1
        business_address2: $address2
        business_city: $city
        business_state_province_region: $state_province_region
        business_postal_code: $postal_code
        business_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
        currency: $currency
        bank_name: $bank_name
        branch_name: $branch_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
    )
}

query

string

Defaults to {}

``200 200

object

data

object

createBusinessBeneficiary

string

``400 400

Updated about 1 year ago

NodeShell

xxxxxxxxxx

const axios = require('axios');

let data = JSON.stringify({

query: `mutation createBusinessBeneficiary (

$user_id: UUID!

$entity_id: UUID!

$email: Email!

$phone: String

$business_address1: String

$business_address2: String

$business_city: String

$business_state_province_region: String

$business_postal_code: PostalCode

$tax_number: TaxNumber

$name_on_bank_account: String

$swift_bic: SwiftBic

$account_number: BankAccountNumber

$routing_code: BankRoutingCode

$currency: ISO4217!

$bank_name: String

$branch_name: String

$bank_address1: String

$bank_address2: String

$bank_city: String

$bank_state_province_region: String

$bank_postal_code: PostalCode

$bank_country: ISO3166_1!,

$business_name: String!,

$business_country: ISO3166_1!

) {

createBusinessBeneficiary (

user_id: $user_id

entity_id: $entity_id

email: $email

phone: $phone

business_name: $business_name,

business_address1: $address1

business_address2: $address2

business_city: $city

business_state_province_region: $state_province_region

business_postal_code: $postal_code

business_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

currency: $currency

bank_name: $bank_name

branch_name: $branch_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

)
}`,

variables: {"entity_id":"","email":"","phone":"","business_name":"","business_address1":"","business_address2":"","business_city":"","business_state_province_region":"","business_postal_code":"","business_country":"","tax_number":"","name_on_bank_account":"","swift_bic":"","account_number":"","routing_code":"","currency":"","bank_name":"","branch_name":"","bank_address1":"","bank_address2":"","bank_city":"","bank_state_province_region":"","bank_postal_code":"","bank_country":""}
});

let config = {

method: 'post',

maxBodyLength: Infinity,

url: 'https://sandbox.external.routefusion.com/graphql',

headers: {

'Content-Type': 'application/json',

'Authorization': '••••••'

},

data : data
};

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

{ "data": { "createBusinessBeneficiary": "edw30do4-8640-42f1-9573-5fe398bdcc92" } }