Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request PATCH \
--url https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id} \
--header 'Content-Type: application/json' \
--header 'X-API-NONCE: <x-api-nonce>' \
--header 'X-API-SIGNATURE: <x-api-signature>' \
--header 'X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>' \
--header 'X-API-TIMESTAMP: <x-api-timestamp>' \
--data '
{
"external_bank_account": {
"bank_name": "<string>",
"name_on_account": "<string>",
"address_on_account": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"routing_number": "<string>",
"account_number": "<string>"
}
}
'import requests
url = "https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id}"
payload = { "external_bank_account": {
"bank_name": "<string>",
"name_on_account": "<string>",
"address_on_account": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"routing_number": "<string>",
"account_number": "<string>"
} }
headers = {
"X-API-SIGNATURE": "<x-api-signature>",
"X-API-TIMESTAMP": "<x-api-timestamp>",
"X-API-NONCE": "<x-api-nonce>",
"X-API-SUBSCRIPTION-KEY": "<x-api-subscription-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-SIGNATURE': '<x-api-signature>',
'X-API-TIMESTAMP': '<x-api-timestamp>',
'X-API-NONCE': '<x-api-nonce>',
'X-API-SUBSCRIPTION-KEY': '<x-api-subscription-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external_bank_account: {
bank_name: '<string>',
name_on_account: '<string>',
address_on_account: {
street_1: '<string>',
street_2: '<string>',
city: '<string>',
state: '<string>',
zip_code: '<string>',
country: '<string>'
},
routing_number: '<string>',
account_number: '<string>'
}
})
};
fetch('https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_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://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_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([
'external_bank_account' => [
'bank_name' => '<string>',
'name_on_account' => '<string>',
'address_on_account' => [
'street_1' => '<string>',
'street_2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip_code' => '<string>',
'country' => '<string>'
],
'routing_number' => '<string>',
'account_number' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-NONCE: <x-api-nonce>",
"X-API-SIGNATURE: <x-api-signature>",
"X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>",
"X-API-TIMESTAMP: <x-api-timestamp>"
],
]);
$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/partner/clover/customers/external_bank_account/{external_bank_account_id}"
payload := strings.NewReader("{\n \"external_bank_account\": {\n \"bank_name\": \"<string>\",\n \"name_on_account\": \"<string>\",\n \"address_on_account\": {\n \"street_1\": \"<string>\",\n \"street_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"routing_number\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-SIGNATURE", "<x-api-signature>")
req.Header.Add("X-API-TIMESTAMP", "<x-api-timestamp>")
req.Header.Add("X-API-NONCE", "<x-api-nonce>")
req.Header.Add("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-key>")
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://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id}")
.header("X-API-SIGNATURE", "<x-api-signature>")
.header("X-API-TIMESTAMP", "<x-api-timestamp>")
.header("X-API-NONCE", "<x-api-nonce>")
.header("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_bank_account\": {\n \"bank_name\": \"<string>\",\n \"name_on_account\": \"<string>\",\n \"address_on_account\": {\n \"street_1\": \"<string>\",\n \"street_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"routing_number\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-SIGNATURE"] = '<x-api-signature>'
request["X-API-TIMESTAMP"] = '<x-api-timestamp>'
request["X-API-NONCE"] = '<x-api-nonce>'
request["X-API-SUBSCRIPTION-KEY"] = '<x-api-subscription-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_bank_account\": {\n \"bank_name\": \"<string>\",\n \"name_on_account\": \"<string>\",\n \"address_on_account\": {\n \"street_1\": \"<string>\",\n \"street_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"routing_number\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"external_account_id": "<string>",
"external_account_number": "<string>",
"external_account_title": "<string>",
"external_institution_aba": "<string>",
"external_institution_name": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Given an external bank account ID, update its information.
curl --request PATCH \
--url https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id} \
--header 'Content-Type: application/json' \
--header 'X-API-NONCE: <x-api-nonce>' \
--header 'X-API-SIGNATURE: <x-api-signature>' \
--header 'X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>' \
--header 'X-API-TIMESTAMP: <x-api-timestamp>' \
--data '
{
"external_bank_account": {
"bank_name": "<string>",
"name_on_account": "<string>",
"address_on_account": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"routing_number": "<string>",
"account_number": "<string>"
}
}
'import requests
url = "https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id}"
payload = { "external_bank_account": {
"bank_name": "<string>",
"name_on_account": "<string>",
"address_on_account": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"routing_number": "<string>",
"account_number": "<string>"
} }
headers = {
"X-API-SIGNATURE": "<x-api-signature>",
"X-API-TIMESTAMP": "<x-api-timestamp>",
"X-API-NONCE": "<x-api-nonce>",
"X-API-SUBSCRIPTION-KEY": "<x-api-subscription-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-SIGNATURE': '<x-api-signature>',
'X-API-TIMESTAMP': '<x-api-timestamp>',
'X-API-NONCE': '<x-api-nonce>',
'X-API-SUBSCRIPTION-KEY': '<x-api-subscription-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external_bank_account: {
bank_name: '<string>',
name_on_account: '<string>',
address_on_account: {
street_1: '<string>',
street_2: '<string>',
city: '<string>',
state: '<string>',
zip_code: '<string>',
country: '<string>'
},
routing_number: '<string>',
account_number: '<string>'
}
})
};
fetch('https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_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://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_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([
'external_bank_account' => [
'bank_name' => '<string>',
'name_on_account' => '<string>',
'address_on_account' => [
'street_1' => '<string>',
'street_2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip_code' => '<string>',
'country' => '<string>'
],
'routing_number' => '<string>',
'account_number' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-NONCE: <x-api-nonce>",
"X-API-SIGNATURE: <x-api-signature>",
"X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>",
"X-API-TIMESTAMP: <x-api-timestamp>"
],
]);
$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/partner/clover/customers/external_bank_account/{external_bank_account_id}"
payload := strings.NewReader("{\n \"external_bank_account\": {\n \"bank_name\": \"<string>\",\n \"name_on_account\": \"<string>\",\n \"address_on_account\": {\n \"street_1\": \"<string>\",\n \"street_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"routing_number\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-SIGNATURE", "<x-api-signature>")
req.Header.Add("X-API-TIMESTAMP", "<x-api-timestamp>")
req.Header.Add("X-API-NONCE", "<x-api-nonce>")
req.Header.Add("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-key>")
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://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id}")
.header("X-API-SIGNATURE", "<x-api-signature>")
.header("X-API-TIMESTAMP", "<x-api-timestamp>")
.header("X-API-NONCE", "<x-api-nonce>")
.header("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_bank_account\": {\n \"bank_name\": \"<string>\",\n \"name_on_account\": \"<string>\",\n \"address_on_account\": {\n \"street_1\": \"<string>\",\n \"street_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"routing_number\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/partner/clover/customers/external_bank_account/{external_bank_account_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-SIGNATURE"] = '<x-api-signature>'
request["X-API-TIMESTAMP"] = '<x-api-timestamp>'
request["X-API-NONCE"] = '<x-api-nonce>'
request["X-API-SUBSCRIPTION-KEY"] = '<x-api-subscription-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_bank_account\": {\n \"bank_name\": \"<string>\",\n \"name_on_account\": \"<string>\",\n \"address_on_account\": {\n \"street_1\": \"<string>\",\n \"street_2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"routing_number\": \"<string>\",\n \"account_number\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"external_account_id": "<string>",
"external_account_number": "<string>",
"external_account_title": "<string>",
"external_institution_aba": "<string>",
"external_institution_name": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Signature header
Timestamp header
Nonce header
Account ID header
Schema to deserialize the customer bank account request.
Represent a Customer External Bank Account.
Show child attributes