Update a beneficiary (V2)
curl --request PATCH \
--url https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_reference": "<string>",
"phone_number": "<string>",
"payouts_email": "jsmith@example.com",
"identification_type": "<string>",
"identification_value": "<string>",
"notifications": {
"enabled": true,
"emails": [
"<string>"
]
},
"address": {
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>",
"country_code": "<string>"
},
"bank_account": {
"holder_name": "<string>",
"number": "<string>",
"iban": "<string>",
"type": "<string>",
"currency_code": "<string>",
"bank": {
"swift_code": "<string>",
"name": "<string>",
"branch_code": "<string>",
"country_code": "<string>",
"address_line": "<string>",
"local_routing_identifier": "<string>"
},
"correspondent_bank": {
"swift_code": "<string>",
"account_number": "<string>"
}
},
"russian_details": {
"inn": "<string>",
"kpp": "<string>",
"kbk": "<string>",
"kio": "<string>",
"vo": "<string>",
"central_bank_account": "<string>"
},
"payment_instructions": {
"purpose_of_payment_code": "<string>",
"permanent_payment_reference": "<string>",
"purpose_of_payment_narrative": "<string>"
}
}
'import requests
url = "https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}"
payload = {
"name": "<string>",
"external_reference": "<string>",
"phone_number": "<string>",
"payouts_email": "jsmith@example.com",
"identification_type": "<string>",
"identification_value": "<string>",
"notifications": {
"enabled": True,
"emails": ["<string>"]
},
"address": {
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>",
"country_code": "<string>"
},
"bank_account": {
"holder_name": "<string>",
"number": "<string>",
"iban": "<string>",
"type": "<string>",
"currency_code": "<string>",
"bank": {
"swift_code": "<string>",
"name": "<string>",
"branch_code": "<string>",
"country_code": "<string>",
"address_line": "<string>",
"local_routing_identifier": "<string>"
},
"correspondent_bank": {
"swift_code": "<string>",
"account_number": "<string>"
}
},
"russian_details": {
"inn": "<string>",
"kpp": "<string>",
"kbk": "<string>",
"kio": "<string>",
"vo": "<string>",
"central_bank_account": "<string>"
},
"payment_instructions": {
"purpose_of_payment_code": "<string>",
"permanent_payment_reference": "<string>",
"purpose_of_payment_narrative": "<string>"
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
external_reference: '<string>',
phone_number: '<string>',
payouts_email: 'jsmith@example.com',
identification_type: '<string>',
identification_value: '<string>',
notifications: {enabled: true, emails: ['<string>']},
address: {
street_name: '<string>',
building_number: '<string>',
floor: '<string>',
apartment_office_number: '<string>',
city: '<string>',
state: '<string>',
post_code: '<string>',
country_code: '<string>'
},
bank_account: {
holder_name: '<string>',
number: '<string>',
iban: '<string>',
type: '<string>',
currency_code: '<string>',
bank: {
swift_code: '<string>',
name: '<string>',
branch_code: '<string>',
country_code: '<string>',
address_line: '<string>',
local_routing_identifier: '<string>'
},
correspondent_bank: {swift_code: '<string>', account_number: '<string>'}
},
russian_details: {
inn: '<string>',
kpp: '<string>',
kbk: '<string>',
kio: '<string>',
vo: '<string>',
central_bank_account: '<string>'
},
payment_instructions: {
purpose_of_payment_code: '<string>',
permanent_payment_reference: '<string>',
purpose_of_payment_narrative: '<string>'
}
})
};
fetch('https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'external_reference' => '<string>',
'phone_number' => '<string>',
'payouts_email' => 'jsmith@example.com',
'identification_type' => '<string>',
'identification_value' => '<string>',
'notifications' => [
'enabled' => true,
'emails' => [
'<string>'
]
],
'address' => [
'street_name' => '<string>',
'building_number' => '<string>',
'floor' => '<string>',
'apartment_office_number' => '<string>',
'city' => '<string>',
'state' => '<string>',
'post_code' => '<string>',
'country_code' => '<string>'
],
'bank_account' => [
'holder_name' => '<string>',
'number' => '<string>',
'iban' => '<string>',
'type' => '<string>',
'currency_code' => '<string>',
'bank' => [
'swift_code' => '<string>',
'name' => '<string>',
'branch_code' => '<string>',
'country_code' => '<string>',
'address_line' => '<string>',
'local_routing_identifier' => '<string>'
],
'correspondent_bank' => [
'swift_code' => '<string>',
'account_number' => '<string>'
]
],
'russian_details' => [
'inn' => '<string>',
'kpp' => '<string>',
'kbk' => '<string>',
'kio' => '<string>',
'vo' => '<string>',
'central_bank_account' => '<string>'
],
'payment_instructions' => [
'purpose_of_payment_code' => '<string>',
'permanent_payment_reference' => '<string>',
'purpose_of_payment_narrative' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"payouts_email\": \"jsmith@example.com\",\n \"identification_type\": \"<string>\",\n \"identification_value\": \"<string>\",\n \"notifications\": {\n \"enabled\": true,\n \"emails\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"street_name\": \"<string>\",\n \"building_number\": \"<string>\",\n \"floor\": \"<string>\",\n \"apartment_office_number\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"post_code\": \"<string>\",\n \"country_code\": \"<string>\"\n },\n \"bank_account\": {\n \"holder_name\": \"<string>\",\n \"number\": \"<string>\",\n \"iban\": \"<string>\",\n \"type\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"bank\": {\n \"swift_code\": \"<string>\",\n \"name\": \"<string>\",\n \"branch_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"address_line\": \"<string>\",\n \"local_routing_identifier\": \"<string>\"\n },\n \"correspondent_bank\": {\n \"swift_code\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n },\n \"russian_details\": {\n \"inn\": \"<string>\",\n \"kpp\": \"<string>\",\n \"kbk\": \"<string>\",\n \"kio\": \"<string>\",\n \"vo\": \"<string>\",\n \"central_bank_account\": \"<string>\"\n },\n \"payment_instructions\": {\n \"purpose_of_payment_code\": \"<string>\",\n \"permanent_payment_reference\": \"<string>\",\n \"purpose_of_payment_narrative\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"payouts_email\": \"jsmith@example.com\",\n \"identification_type\": \"<string>\",\n \"identification_value\": \"<string>\",\n \"notifications\": {\n \"enabled\": true,\n \"emails\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"street_name\": \"<string>\",\n \"building_number\": \"<string>\",\n \"floor\": \"<string>\",\n \"apartment_office_number\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"post_code\": \"<string>\",\n \"country_code\": \"<string>\"\n },\n \"bank_account\": {\n \"holder_name\": \"<string>\",\n \"number\": \"<string>\",\n \"iban\": \"<string>\",\n \"type\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"bank\": {\n \"swift_code\": \"<string>\",\n \"name\": \"<string>\",\n \"branch_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"address_line\": \"<string>\",\n \"local_routing_identifier\": \"<string>\"\n },\n \"correspondent_bank\": {\n \"swift_code\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n },\n \"russian_details\": {\n \"inn\": \"<string>\",\n \"kpp\": \"<string>\",\n \"kbk\": \"<string>\",\n \"kio\": \"<string>\",\n \"vo\": \"<string>\",\n \"central_bank_account\": \"<string>\"\n },\n \"payment_instructions\": {\n \"purpose_of_payment_code\": \"<string>\",\n \"permanent_payment_reference\": \"<string>\",\n \"purpose_of_payment_narrative\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"payouts_email\": \"jsmith@example.com\",\n \"identification_type\": \"<string>\",\n \"identification_value\": \"<string>\",\n \"notifications\": {\n \"enabled\": true,\n \"emails\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"street_name\": \"<string>\",\n \"building_number\": \"<string>\",\n \"floor\": \"<string>\",\n \"apartment_office_number\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"post_code\": \"<string>\",\n \"country_code\": \"<string>\"\n },\n \"bank_account\": {\n \"holder_name\": \"<string>\",\n \"number\": \"<string>\",\n \"iban\": \"<string>\",\n \"type\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"bank\": {\n \"swift_code\": \"<string>\",\n \"name\": \"<string>\",\n \"branch_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"address_line\": \"<string>\",\n \"local_routing_identifier\": \"<string>\"\n },\n \"correspondent_bank\": {\n \"swift_code\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n },\n \"russian_details\": {\n \"inn\": \"<string>\",\n \"kpp\": \"<string>\",\n \"kbk\": \"<string>\",\n \"kio\": \"<string>\",\n \"vo\": \"<string>\",\n \"central_bank_account\": \"<string>\"\n },\n \"payment_instructions\": {\n \"purpose_of_payment_code\": \"<string>\",\n \"permanent_payment_reference\": \"<string>\",\n \"purpose_of_payment_narrative\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"active": true,
"editable": true,
"is_first_party": true,
"created_date": "<string>",
"notifications": {
"enabled": true,
"emails": [
"<string>"
]
},
"address": {
"country": {
"code_alpha2": "<string>",
"code_alpha3": "<string>",
"name": "<string>"
},
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"address_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
},
"bank_account": {
"id": 123,
"holder_name": "<string>",
"currency_code": "<string>",
"bank": {
"address": {
"country": {
"code_alpha2": "<string>",
"code_alpha3": "<string>",
"name": "<string>"
},
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"address_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
},
"swift_code": "<string>",
"name": "<string>",
"branch_code": "<string>",
"local_routing_identifier": "<string>"
},
"russian_details": {
"inn": "<string>",
"kpp": "<string>",
"kbk": "<string>",
"kio": "<string>",
"vo": "<string>",
"central_bank_account": "<string>"
},
"payment_instructions": {
"purpose_of_payment_code": "<string>",
"permanent_payment_reference": "<string>",
"purpose_of_payment_narrative": "<string>"
},
"is_intra": true,
"number": "<string>",
"iban": "<string>",
"type": "<string>",
"correspondent_bank": {
"swift_code": "<string>",
"account_number": "<string>"
}
},
"aml_status": "<string>",
"name": "<string>",
"type": "personal",
"external_reference": "<string>",
"phone_number": "<string>",
"payouts_email": "<string>",
"identification_type": "<string>",
"identification_value": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}Beneficiaries V2
Update a beneficiary (V2)
Update an existing beneficiary by beneficiary’s identifier.
PATCH
/
v2
/
beneficiaries
/
{beneficiary_id}
Update a beneficiary (V2)
curl --request PATCH \
--url https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_reference": "<string>",
"phone_number": "<string>",
"payouts_email": "jsmith@example.com",
"identification_type": "<string>",
"identification_value": "<string>",
"notifications": {
"enabled": true,
"emails": [
"<string>"
]
},
"address": {
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>",
"country_code": "<string>"
},
"bank_account": {
"holder_name": "<string>",
"number": "<string>",
"iban": "<string>",
"type": "<string>",
"currency_code": "<string>",
"bank": {
"swift_code": "<string>",
"name": "<string>",
"branch_code": "<string>",
"country_code": "<string>",
"address_line": "<string>",
"local_routing_identifier": "<string>"
},
"correspondent_bank": {
"swift_code": "<string>",
"account_number": "<string>"
}
},
"russian_details": {
"inn": "<string>",
"kpp": "<string>",
"kbk": "<string>",
"kio": "<string>",
"vo": "<string>",
"central_bank_account": "<string>"
},
"payment_instructions": {
"purpose_of_payment_code": "<string>",
"permanent_payment_reference": "<string>",
"purpose_of_payment_narrative": "<string>"
}
}
'import requests
url = "https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}"
payload = {
"name": "<string>",
"external_reference": "<string>",
"phone_number": "<string>",
"payouts_email": "jsmith@example.com",
"identification_type": "<string>",
"identification_value": "<string>",
"notifications": {
"enabled": True,
"emails": ["<string>"]
},
"address": {
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>",
"country_code": "<string>"
},
"bank_account": {
"holder_name": "<string>",
"number": "<string>",
"iban": "<string>",
"type": "<string>",
"currency_code": "<string>",
"bank": {
"swift_code": "<string>",
"name": "<string>",
"branch_code": "<string>",
"country_code": "<string>",
"address_line": "<string>",
"local_routing_identifier": "<string>"
},
"correspondent_bank": {
"swift_code": "<string>",
"account_number": "<string>"
}
},
"russian_details": {
"inn": "<string>",
"kpp": "<string>",
"kbk": "<string>",
"kio": "<string>",
"vo": "<string>",
"central_bank_account": "<string>"
},
"payment_instructions": {
"purpose_of_payment_code": "<string>",
"permanent_payment_reference": "<string>",
"purpose_of_payment_narrative": "<string>"
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
external_reference: '<string>',
phone_number: '<string>',
payouts_email: 'jsmith@example.com',
identification_type: '<string>',
identification_value: '<string>',
notifications: {enabled: true, emails: ['<string>']},
address: {
street_name: '<string>',
building_number: '<string>',
floor: '<string>',
apartment_office_number: '<string>',
city: '<string>',
state: '<string>',
post_code: '<string>',
country_code: '<string>'
},
bank_account: {
holder_name: '<string>',
number: '<string>',
iban: '<string>',
type: '<string>',
currency_code: '<string>',
bank: {
swift_code: '<string>',
name: '<string>',
branch_code: '<string>',
country_code: '<string>',
address_line: '<string>',
local_routing_identifier: '<string>'
},
correspondent_bank: {swift_code: '<string>', account_number: '<string>'}
},
russian_details: {
inn: '<string>',
kpp: '<string>',
kbk: '<string>',
kio: '<string>',
vo: '<string>',
central_bank_account: '<string>'
},
payment_instructions: {
purpose_of_payment_code: '<string>',
permanent_payment_reference: '<string>',
purpose_of_payment_narrative: '<string>'
}
})
};
fetch('https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'external_reference' => '<string>',
'phone_number' => '<string>',
'payouts_email' => 'jsmith@example.com',
'identification_type' => '<string>',
'identification_value' => '<string>',
'notifications' => [
'enabled' => true,
'emails' => [
'<string>'
]
],
'address' => [
'street_name' => '<string>',
'building_number' => '<string>',
'floor' => '<string>',
'apartment_office_number' => '<string>',
'city' => '<string>',
'state' => '<string>',
'post_code' => '<string>',
'country_code' => '<string>'
],
'bank_account' => [
'holder_name' => '<string>',
'number' => '<string>',
'iban' => '<string>',
'type' => '<string>',
'currency_code' => '<string>',
'bank' => [
'swift_code' => '<string>',
'name' => '<string>',
'branch_code' => '<string>',
'country_code' => '<string>',
'address_line' => '<string>',
'local_routing_identifier' => '<string>'
],
'correspondent_bank' => [
'swift_code' => '<string>',
'account_number' => '<string>'
]
],
'russian_details' => [
'inn' => '<string>',
'kpp' => '<string>',
'kbk' => '<string>',
'kio' => '<string>',
'vo' => '<string>',
'central_bank_account' => '<string>'
],
'payment_instructions' => [
'purpose_of_payment_code' => '<string>',
'permanent_payment_reference' => '<string>',
'purpose_of_payment_narrative' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"payouts_email\": \"jsmith@example.com\",\n \"identification_type\": \"<string>\",\n \"identification_value\": \"<string>\",\n \"notifications\": {\n \"enabled\": true,\n \"emails\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"street_name\": \"<string>\",\n \"building_number\": \"<string>\",\n \"floor\": \"<string>\",\n \"apartment_office_number\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"post_code\": \"<string>\",\n \"country_code\": \"<string>\"\n },\n \"bank_account\": {\n \"holder_name\": \"<string>\",\n \"number\": \"<string>\",\n \"iban\": \"<string>\",\n \"type\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"bank\": {\n \"swift_code\": \"<string>\",\n \"name\": \"<string>\",\n \"branch_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"address_line\": \"<string>\",\n \"local_routing_identifier\": \"<string>\"\n },\n \"correspondent_bank\": {\n \"swift_code\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n },\n \"russian_details\": {\n \"inn\": \"<string>\",\n \"kpp\": \"<string>\",\n \"kbk\": \"<string>\",\n \"kio\": \"<string>\",\n \"vo\": \"<string>\",\n \"central_bank_account\": \"<string>\"\n },\n \"payment_instructions\": {\n \"purpose_of_payment_code\": \"<string>\",\n \"permanent_payment_reference\": \"<string>\",\n \"purpose_of_payment_narrative\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"payouts_email\": \"jsmith@example.com\",\n \"identification_type\": \"<string>\",\n \"identification_value\": \"<string>\",\n \"notifications\": {\n \"enabled\": true,\n \"emails\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"street_name\": \"<string>\",\n \"building_number\": \"<string>\",\n \"floor\": \"<string>\",\n \"apartment_office_number\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"post_code\": \"<string>\",\n \"country_code\": \"<string>\"\n },\n \"bank_account\": {\n \"holder_name\": \"<string>\",\n \"number\": \"<string>\",\n \"iban\": \"<string>\",\n \"type\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"bank\": {\n \"swift_code\": \"<string>\",\n \"name\": \"<string>\",\n \"branch_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"address_line\": \"<string>\",\n \"local_routing_identifier\": \"<string>\"\n },\n \"correspondent_bank\": {\n \"swift_code\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n },\n \"russian_details\": {\n \"inn\": \"<string>\",\n \"kpp\": \"<string>\",\n \"kbk\": \"<string>\",\n \"kio\": \"<string>\",\n \"vo\": \"<string>\",\n \"central_bank_account\": \"<string>\"\n },\n \"payment_instructions\": {\n \"purpose_of_payment_code\": \"<string>\",\n \"permanent_payment_reference\": \"<string>\",\n \"purpose_of_payment_narrative\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment}.ebury.io/v2/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"external_reference\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"payouts_email\": \"jsmith@example.com\",\n \"identification_type\": \"<string>\",\n \"identification_value\": \"<string>\",\n \"notifications\": {\n \"enabled\": true,\n \"emails\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"street_name\": \"<string>\",\n \"building_number\": \"<string>\",\n \"floor\": \"<string>\",\n \"apartment_office_number\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"post_code\": \"<string>\",\n \"country_code\": \"<string>\"\n },\n \"bank_account\": {\n \"holder_name\": \"<string>\",\n \"number\": \"<string>\",\n \"iban\": \"<string>\",\n \"type\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"bank\": {\n \"swift_code\": \"<string>\",\n \"name\": \"<string>\",\n \"branch_code\": \"<string>\",\n \"country_code\": \"<string>\",\n \"address_line\": \"<string>\",\n \"local_routing_identifier\": \"<string>\"\n },\n \"correspondent_bank\": {\n \"swift_code\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n },\n \"russian_details\": {\n \"inn\": \"<string>\",\n \"kpp\": \"<string>\",\n \"kbk\": \"<string>\",\n \"kio\": \"<string>\",\n \"vo\": \"<string>\",\n \"central_bank_account\": \"<string>\"\n },\n \"payment_instructions\": {\n \"purpose_of_payment_code\": \"<string>\",\n \"permanent_payment_reference\": \"<string>\",\n \"purpose_of_payment_narrative\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"active": true,
"editable": true,
"is_first_party": true,
"created_date": "<string>",
"notifications": {
"enabled": true,
"emails": [
"<string>"
]
},
"address": {
"country": {
"code_alpha2": "<string>",
"code_alpha3": "<string>",
"name": "<string>"
},
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"address_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
},
"bank_account": {
"id": 123,
"holder_name": "<string>",
"currency_code": "<string>",
"bank": {
"address": {
"country": {
"code_alpha2": "<string>",
"code_alpha3": "<string>",
"name": "<string>"
},
"street_name": "<string>",
"building_number": "<string>",
"floor": "<string>",
"apartment_office_number": "<string>",
"address_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
},
"swift_code": "<string>",
"name": "<string>",
"branch_code": "<string>",
"local_routing_identifier": "<string>"
},
"russian_details": {
"inn": "<string>",
"kpp": "<string>",
"kbk": "<string>",
"kio": "<string>",
"vo": "<string>",
"central_bank_account": "<string>"
},
"payment_instructions": {
"purpose_of_payment_code": "<string>",
"permanent_payment_reference": "<string>",
"purpose_of_payment_narrative": "<string>"
},
"is_intra": true,
"number": "<string>",
"iban": "<string>",
"type": "<string>",
"correspondent_bank": {
"swift_code": "<string>",
"account_number": "<string>"
}
},
"aml_status": "<string>",
"name": "<string>",
"type": "personal",
"external_reference": "<string>",
"phone_number": "<string>",
"payouts_email": "<string>",
"identification_type": "<string>",
"identification_value": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}{
"code": "<string>",
"details": "<string>",
"message": "<string>"
}Headers
The version of the beneficiary validation policy to apply. The latest one is used when omitted.
The access token.
Path Parameters
The identifier of a beneficiary.
Query Parameters
The identifier of a client.
Body
application/json
The fields of the beneficiary to update.
Partial update: every field is optional, and only the fields actually sent are forwarded. Omitting a field leaves it untouched; passing it as null clears it. identification_type and identification_value must be sent together.
The alias/display name of the beneficiary. The beneficiary's name is bank_account.holder_name.
Minimum string length:
1The type of the beneficiary.
Available options:
personal, business, null The unique external reference submitted by the client for the beneficiary.
Minimum string length:
1The phone number of the beneficiary.
Minimum string length:
1The email of the beneficiary to use during payouts.
The identification (e.g. TAX ID) type of the beneficiary.
Minimum string length:
1The identification (e.g. TAX ID) value of the beneficiary.
Minimum string length:
1The notification preferences of a beneficiary.
Show child attributes
Show child attributes
The address of a beneficiary or of its bank, for an update. None of the fields are required.
Show child attributes
Show child attributes
The bank account of a beneficiary, for an update. None of the fields are required.
Show child attributes
Show child attributes
The Russia-specific data of a bank account.
Show child attributes
Show child attributes
The default payment data used when paying the beneficiary.
Show child attributes
Show child attributes
Response
The data of a beneficiary.
The data of a beneficiary.
The identifier of the beneficiary.
True if beneficiary is active, False otherwise.
True if beneficiary is editable, False otherwise.
True if beneficiary is a first party, False otherwise.
The date and time when the beneficiary was created.
The notification preferences of a beneficiary.
Show child attributes
Show child attributes
An address of a beneficiary or of a bank.
Show child attributes
Show child attributes
The bank account of a beneficiary.
Show child attributes
Show child attributes
The AML/screening status of the beneficiary.
The alias/display name of the beneficiary. The beneficiary's name is bank_account.holder_name.
The type of the beneficiary.
Available options:
personal, business, null The unique external reference submitted by the client for the beneficiary.
The phone number of the beneficiary.
The email of the beneficiary to use during payouts.
The identification (e.g. TAX ID) type of the beneficiary.
The identification (e.g. TAX ID) value of the beneficiary.