Update beneficiary
curl --request PATCH \
--url http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"country": "<string>",
"companyName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"currencyCode": "USD",
"iban": "<string>",
"accountNumber": "<string>",
"bankBic": "<string>",
"wireRoutingNumber": "<string>",
"achRoutingNumber": "<string>",
"intermediaryBank": "<string>"
}
'import requests
url = "http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}"
payload = {
"country": "<string>",
"companyName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"currencyCode": "USD",
"iban": "<string>",
"accountNumber": "<string>",
"bankBic": "<string>",
"wireRoutingNumber": "<string>",
"achRoutingNumber": "<string>",
"intermediaryBank": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-key': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
country: '<string>',
companyName: '<string>',
address: '<string>',
zipCode: '<string>',
currencyCode: 'USD',
iban: '<string>',
accountNumber: '<string>',
bankBic: '<string>',
wireRoutingNumber: '<string>',
achRoutingNumber: '<string>',
intermediaryBank: '<string>'
})
};
fetch('http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{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_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{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([
'country' => '<string>',
'companyName' => '<string>',
'address' => '<string>',
'zipCode' => '<string>',
'currencyCode' => 'USD',
'iban' => '<string>',
'accountNumber' => '<string>',
'bankBic' => '<string>',
'wireRoutingNumber' => '<string>',
'achRoutingNumber' => '<string>',
'intermediaryBank' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}"
payload := strings.NewReader("{\n \"country\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"currencyCode\": \"USD\",\n \"iban\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankBic\": \"<string>\",\n \"wireRoutingNumber\": \"<string>\",\n \"achRoutingNumber\": \"<string>\",\n \"intermediaryBank\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"country\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"currencyCode\": \"USD\",\n \"iban\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankBic\": \"<string>\",\n \"wireRoutingNumber\": \"<string>\",\n \"achRoutingNumber\": \"<string>\",\n \"intermediaryBank\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"country\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"currencyCode\": \"USD\",\n \"iban\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankBic\": \"<string>\",\n \"wireRoutingNumber\": \"<string>\",\n \"achRoutingNumber\": \"<string>\",\n \"intermediaryBank\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"customerId": "<string>",
"country": "<string>",
"companyName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"currencyCode": "<string>",
"bankName": "<string>",
"bankBic": "<string>",
"bankCountryCode": "<string>",
"bankAddress": "<string>",
"accountNumber": "<string>",
"iban": "<string>",
"wireRoutingNumber": "<string>",
"achRoutingNumber": "<string>",
"intermediaryBank": "<string>",
"status": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}Beneficiaries
Update beneficiary
Update beneficiary (CORRECTION_REQUESTED only).
PATCH
/
api
/
v1
/
customers
/
{customerId}
/
beneficiaries
/
{id}
Update beneficiary
curl --request PATCH \
--url http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"country": "<string>",
"companyName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"currencyCode": "USD",
"iban": "<string>",
"accountNumber": "<string>",
"bankBic": "<string>",
"wireRoutingNumber": "<string>",
"achRoutingNumber": "<string>",
"intermediaryBank": "<string>"
}
'import requests
url = "http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}"
payload = {
"country": "<string>",
"companyName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"currencyCode": "USD",
"iban": "<string>",
"accountNumber": "<string>",
"bankBic": "<string>",
"wireRoutingNumber": "<string>",
"achRoutingNumber": "<string>",
"intermediaryBank": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-key': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
country: '<string>',
companyName: '<string>',
address: '<string>',
zipCode: '<string>',
currencyCode: 'USD',
iban: '<string>',
accountNumber: '<string>',
bankBic: '<string>',
wireRoutingNumber: '<string>',
achRoutingNumber: '<string>',
intermediaryBank: '<string>'
})
};
fetch('http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{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_PORT => "5000",
CURLOPT_URL => "http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{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([
'country' => '<string>',
'companyName' => '<string>',
'address' => '<string>',
'zipCode' => '<string>',
'currencyCode' => 'USD',
'iban' => '<string>',
'accountNumber' => '<string>',
'bankBic' => '<string>',
'wireRoutingNumber' => '<string>',
'achRoutingNumber' => '<string>',
'intermediaryBank' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}"
payload := strings.NewReader("{\n \"country\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"currencyCode\": \"USD\",\n \"iban\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankBic\": \"<string>\",\n \"wireRoutingNumber\": \"<string>\",\n \"achRoutingNumber\": \"<string>\",\n \"intermediaryBank\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}")
.header("x-api-key", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"country\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"currencyCode\": \"USD\",\n \"iban\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankBic\": \"<string>\",\n \"wireRoutingNumber\": \"<string>\",\n \"achRoutingNumber\": \"<string>\",\n \"intermediaryBank\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5000/api/v1/customers/{customerId}/beneficiaries/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"country\": \"<string>\",\n \"companyName\": \"<string>\",\n \"address\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"currencyCode\": \"USD\",\n \"iban\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankBic\": \"<string>\",\n \"wireRoutingNumber\": \"<string>\",\n \"achRoutingNumber\": \"<string>\",\n \"intermediaryBank\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"customerId": "<string>",
"country": "<string>",
"companyName": "<string>",
"address": "<string>",
"zipCode": "<string>",
"currencyCode": "<string>",
"bankName": "<string>",
"bankBic": "<string>",
"bankCountryCode": "<string>",
"bankAddress": "<string>",
"accountNumber": "<string>",
"iban": "<string>",
"wireRoutingNumber": "<string>",
"achRoutingNumber": "<string>",
"intermediaryBank": "<string>",
"status": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}Authorizations
Nuvera API application secret key
RS256 per-request signed JWT
Body
application/json
Minimum string length:
1Required string length:
1 - 200Minimum string length:
1Minimum string length:
1Allowed value:
"USD"Response
default - application/json