curl --request PUT \
--url http://localhost:8080/api/v1/beneficiaries/{beneficiary_id} \
--header 'Content-Type: application/json' \
--data '
{
"account_number": "<string>",
"address": "<string>",
"bank_address": "<string>",
"bank_name": "<string>",
"bic": "<string>",
"city": "<string>",
"country_code": "<string>",
"display": true,
"iban": "<string>",
"name": "<string>",
"postal_code": "<string>",
"routing_number": "<string>",
"swift_code": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}"
payload = {
"account_number": "<string>",
"address": "<string>",
"bank_address": "<string>",
"bank_name": "<string>",
"bic": "<string>",
"city": "<string>",
"country_code": "<string>",
"display": True,
"iban": "<string>",
"name": "<string>",
"postal_code": "<string>",
"routing_number": "<string>",
"swift_code": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
account_number: '<string>',
address: '<string>',
bank_address: '<string>',
bank_name: '<string>',
bic: '<string>',
city: '<string>',
country_code: '<string>',
display: true,
iban: '<string>',
name: '<string>',
postal_code: '<string>',
routing_number: '<string>',
swift_code: '<string>'
})
};
fetch('http://localhost:8080/api/v1/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'account_number' => '<string>',
'address' => '<string>',
'bank_address' => '<string>',
'bank_name' => '<string>',
'bic' => '<string>',
'city' => '<string>',
'country_code' => '<string>',
'display' => true,
'iban' => '<string>',
'name' => '<string>',
'postal_code' => '<string>',
'routing_number' => '<string>',
'swift_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}"
payload := strings.NewReader("{\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bic\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"display\": true,\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"routing_number\": \"<string>\",\n \"swift_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}")
.header("Content-Type", "application/json")
.body("{\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bic\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"display\": true,\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"routing_number\": \"<string>\",\n \"swift_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bic\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"display\": true,\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"routing_number\": \"<string>\",\n \"swift_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"beneficiary_type": "PERSON",
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"display": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"account_number": "<string>",
"address": "<string>",
"bank_address": "<string>",
"bank_name": "<string>",
"bic": "<string>",
"city": "<string>",
"country_code": "<string>",
"iban": "<string>",
"postal_code": "<string>",
"routing_number": "<string>",
"swift_code": "<string>"
}Update Beneficiary
Update a beneficiary (partial). Payment details are re-validated and the beneficiary must still have either an IBAN or an account number. Set display=false to hide it instead of deleting.
curl --request PUT \
--url http://localhost:8080/api/v1/beneficiaries/{beneficiary_id} \
--header 'Content-Type: application/json' \
--data '
{
"account_number": "<string>",
"address": "<string>",
"bank_address": "<string>",
"bank_name": "<string>",
"bic": "<string>",
"city": "<string>",
"country_code": "<string>",
"display": true,
"iban": "<string>",
"name": "<string>",
"postal_code": "<string>",
"routing_number": "<string>",
"swift_code": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}"
payload = {
"account_number": "<string>",
"address": "<string>",
"bank_address": "<string>",
"bank_name": "<string>",
"bic": "<string>",
"city": "<string>",
"country_code": "<string>",
"display": True,
"iban": "<string>",
"name": "<string>",
"postal_code": "<string>",
"routing_number": "<string>",
"swift_code": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
account_number: '<string>',
address: '<string>',
bank_address: '<string>',
bank_name: '<string>',
bic: '<string>',
city: '<string>',
country_code: '<string>',
display: true,
iban: '<string>',
name: '<string>',
postal_code: '<string>',
routing_number: '<string>',
swift_code: '<string>'
})
};
fetch('http://localhost:8080/api/v1/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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'account_number' => '<string>',
'address' => '<string>',
'bank_address' => '<string>',
'bank_name' => '<string>',
'bic' => '<string>',
'city' => '<string>',
'country_code' => '<string>',
'display' => true,
'iban' => '<string>',
'name' => '<string>',
'postal_code' => '<string>',
'routing_number' => '<string>',
'swift_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}"
payload := strings.NewReader("{\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bic\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"display\": true,\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"routing_number\": \"<string>\",\n \"swift_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}")
.header("Content-Type", "application/json")
.body("{\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bic\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"display\": true,\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"routing_number\": \"<string>\",\n \"swift_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/beneficiaries/{beneficiary_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"bic\": \"<string>\",\n \"city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"display\": true,\n \"iban\": \"<string>\",\n \"name\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"routing_number\": \"<string>\",\n \"swift_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"beneficiary_type": "PERSON",
"client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"display": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"account_number": "<string>",
"address": "<string>",
"bank_address": "<string>",
"bank_name": "<string>",
"bic": "<string>",
"city": "<string>",
"country_code": "<string>",
"iban": "<string>",
"postal_code": "<string>",
"routing_number": "<string>",
"swift_code": "<string>"
}Path Parameters
Beneficiary UUID
Body
Request to update an existing beneficiary Note: Nested Option fields (Option<Option>) don't support derive(Validate), so validation for IBAN, BIC, etc. is done manually via validate() method
Beneficiary Type - Individual person or company
PERSON, COMPANY Response
Beneficiary updated successfully
Beneficiary - Payment recipient entity
Beneficiary Type - Individual person or company
PERSON, COMPANY Whether beneficiary is displayed to users
Beneficiary name (person or company name)
Bank account number (non-SEPA)
Bank address
Bank name
Bank Identifier Code (SEPA)
ISO 3166-1 alpha-3 country code
International Bank Account Number (SEPA)
US ABA routing number
SWIFT code for international transfers