Bank accounts
Update a bank account
Replaces the account’s editable details (holder name, corridor, routing) and re-runs Cleff-side validation, resetting validation_status. Malformed details are rejected (422) and the row is left unchanged. The identifier is re-encrypted at rest; the response is the masked projection.
PUT
/
v1
/
beneficiaries
/
{id}
/
bank-accounts
/
{accountId}
Edit a Beneficiary’s bank account
curl --request PUT \
--url https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
}
'import requests
url = "https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}"
payload = {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_holder_name: '<string>',
country: '<string>',
currency: '<string>',
account_number: '<string>',
routing_code: '<string>',
iban: '<string>',
swift_bic: '<string>',
clabe: '<string>',
pix_key: '<string>',
bank_name: '<string>'
})
};
fetch('https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}', 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://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}",
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_holder_name' => '<string>',
'country' => '<string>',
'currency' => '<string>',
'account_number' => '<string>',
'routing_code' => '<string>',
'iban' => '<string>',
'swift_bic' => '<string>',
'clabe' => '<string>',
'pix_key' => '<string>',
'bank_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}"
payload := strings.NewReader("{\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"bank_account": {
"id": "<string>",
"account_holder_name": "<string>",
"currency": "<string>",
"country": "<string>",
"status": "verified",
"validation_status": "unvalidated",
"payout_usable": true,
"last4": "<string>",
"account_type": "checking",
"rail_rejection_reason": {}
}
}Authorizations
Cleff API key issued to a Business that self-registers via POST /v1/registration
Body
application/json
ISO 3166-1 alpha-2 of the bank country
ISO 4217 currency code
Domestic account number (US/JP/etc.)
US ABA, UK sort code, BR branch_code, etc.
IBAN — required for European corridors
SWIFT/BIC — required for cross-border SWIFT routing
CLABE — Mexican domestic routing (18 digits)
Pix key — Brazilian instant-payment identifier
ACH account type (US). Defaults to checking at enrollment when unset.
Available options:
checking, savings Response
Show child attributes
Show child attributes
⌘I
Edit a Beneficiary’s bank account
curl --request PUT \
--url https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
}
'import requests
url = "https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}"
payload = {
"account_holder_name": "<string>",
"country": "<string>",
"currency": "<string>",
"account_number": "<string>",
"routing_code": "<string>",
"iban": "<string>",
"swift_bic": "<string>",
"clabe": "<string>",
"pix_key": "<string>",
"bank_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_holder_name: '<string>',
country: '<string>',
currency: '<string>',
account_number: '<string>',
routing_code: '<string>',
iban: '<string>',
swift_bic: '<string>',
clabe: '<string>',
pix_key: '<string>',
bank_name: '<string>'
})
};
fetch('https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}', 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://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}",
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_holder_name' => '<string>',
'country' => '<string>',
'currency' => '<string>',
'account_number' => '<string>',
'routing_code' => '<string>',
'iban' => '<string>',
'swift_bic' => '<string>',
'clabe' => '<string>',
'pix_key' => '<string>',
'bank_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}"
payload := strings.NewReader("{\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries/{id}/bank-accounts/{accountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"currency\": \"<string>\",\n \"account_number\": \"<string>\",\n \"routing_code\": \"<string>\",\n \"iban\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pix_key\": \"<string>\",\n \"bank_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"bank_account": {
"id": "<string>",
"account_holder_name": "<string>",
"currency": "<string>",
"country": "<string>",
"status": "verified",
"validation_status": "unvalidated",
"payout_usable": true,
"last4": "<string>",
"account_type": "checking",
"rail_rejection_reason": {}
}
}