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/business/{customer_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 '
{
"business": {
"business_name": "<string>",
"dba": "<string>",
"naics_code": 123,
"business_description": "<string>",
"formation_state": "<string>",
"formation_date": "<string>",
"ein": "<string>",
"business_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"mailing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone": 123,
"email": "<string>",
"website": "<string>",
"backup_withholding": true,
"is_public": true,
"government_affiliated": true,
"affiliated_entities": "<string>",
"operations_abroad": true,
"international_customers_served": true
}
}
'import requests
url = "https://api.example.com/partner/clover/customers/business/{customer_id}"
payload = { "business": {
"business_name": "<string>",
"dba": "<string>",
"naics_code": 123,
"business_description": "<string>",
"formation_state": "<string>",
"formation_date": "<string>",
"ein": "<string>",
"business_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"mailing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone": 123,
"email": "<string>",
"website": "<string>",
"backup_withholding": True,
"is_public": True,
"government_affiliated": True,
"affiliated_entities": "<string>",
"operations_abroad": True,
"international_customers_served": True
} }
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({
business: {
business_name: '<string>',
dba: '<string>',
naics_code: 123,
business_description: '<string>',
formation_state: '<string>',
formation_date: '<string>',
ein: '<string>',
business_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
zip_code: '<string>',
country: '<string>',
street_2: '<string>'
},
mailing_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
zip_code: '<string>',
country: '<string>',
street_2: '<string>'
},
phone: 123,
email: '<string>',
website: '<string>',
backup_withholding: true,
is_public: true,
government_affiliated: true,
affiliated_entities: '<string>',
operations_abroad: true,
international_customers_served: true
}
})
};
fetch('https://api.example.com/partner/clover/customers/business/{customer_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/business/{customer_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([
'business' => [
'business_name' => '<string>',
'dba' => '<string>',
'naics_code' => 123,
'business_description' => '<string>',
'formation_state' => '<string>',
'formation_date' => '<string>',
'ein' => '<string>',
'business_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'mailing_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'phone' => 123,
'email' => '<string>',
'website' => '<string>',
'backup_withholding' => true,
'is_public' => true,
'government_affiliated' => true,
'affiliated_entities' => '<string>',
'operations_abroad' => true,
'international_customers_served' => true
]
]),
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/business/{customer_id}"
payload := strings.NewReader("{\n \"business\": {\n \"business_name\": \"<string>\",\n \"dba\": \"<string>\",\n \"naics_code\": 123,\n \"business_description\": \"<string>\",\n \"formation_state\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"ein\": \"<string>\",\n \"business_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"mailing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone\": 123,\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"backup_withholding\": true,\n \"is_public\": true,\n \"government_affiliated\": true,\n \"affiliated_entities\": \"<string>\",\n \"operations_abroad\": true,\n \"international_customers_served\": true\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/business/{customer_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 \"business\": {\n \"business_name\": \"<string>\",\n \"dba\": \"<string>\",\n \"naics_code\": 123,\n \"business_description\": \"<string>\",\n \"formation_state\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"ein\": \"<string>\",\n \"business_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"mailing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone\": 123,\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"backup_withholding\": true,\n \"is_public\": true,\n \"government_affiliated\": true,\n \"affiliated_entities\": \"<string>\",\n \"operations_abroad\": true,\n \"international_customers_served\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/partner/clover/customers/business/{customer_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 \"business\": {\n \"business_name\": \"<string>\",\n \"dba\": \"<string>\",\n \"naics_code\": 123,\n \"business_description\": \"<string>\",\n \"formation_state\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"ein\": \"<string>\",\n \"business_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"mailing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone\": 123,\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"backup_withholding\": true,\n \"is_public\": true,\n \"government_affiliated\": true,\n \"affiliated_entities\": \"<string>\",\n \"operations_abroad\": true,\n \"international_customers_served\": true\n }\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update a customer business in Alloy and Finxact.
curl --request PATCH \
--url https://api.example.com/partner/clover/customers/business/{customer_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 '
{
"business": {
"business_name": "<string>",
"dba": "<string>",
"naics_code": 123,
"business_description": "<string>",
"formation_state": "<string>",
"formation_date": "<string>",
"ein": "<string>",
"business_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"mailing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone": 123,
"email": "<string>",
"website": "<string>",
"backup_withholding": true,
"is_public": true,
"government_affiliated": true,
"affiliated_entities": "<string>",
"operations_abroad": true,
"international_customers_served": true
}
}
'import requests
url = "https://api.example.com/partner/clover/customers/business/{customer_id}"
payload = { "business": {
"business_name": "<string>",
"dba": "<string>",
"naics_code": 123,
"business_description": "<string>",
"formation_state": "<string>",
"formation_date": "<string>",
"ein": "<string>",
"business_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"mailing_address": {
"street_1": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>",
"street_2": "<string>"
},
"phone": 123,
"email": "<string>",
"website": "<string>",
"backup_withholding": True,
"is_public": True,
"government_affiliated": True,
"affiliated_entities": "<string>",
"operations_abroad": True,
"international_customers_served": True
} }
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({
business: {
business_name: '<string>',
dba: '<string>',
naics_code: 123,
business_description: '<string>',
formation_state: '<string>',
formation_date: '<string>',
ein: '<string>',
business_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
zip_code: '<string>',
country: '<string>',
street_2: '<string>'
},
mailing_address: {
street_1: '<string>',
city: '<string>',
state: '<string>',
zip_code: '<string>',
country: '<string>',
street_2: '<string>'
},
phone: 123,
email: '<string>',
website: '<string>',
backup_withholding: true,
is_public: true,
government_affiliated: true,
affiliated_entities: '<string>',
operations_abroad: true,
international_customers_served: true
}
})
};
fetch('https://api.example.com/partner/clover/customers/business/{customer_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/business/{customer_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([
'business' => [
'business_name' => '<string>',
'dba' => '<string>',
'naics_code' => 123,
'business_description' => '<string>',
'formation_state' => '<string>',
'formation_date' => '<string>',
'ein' => '<string>',
'business_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'mailing_address' => [
'street_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip_code' => '<string>',
'country' => '<string>',
'street_2' => '<string>'
],
'phone' => 123,
'email' => '<string>',
'website' => '<string>',
'backup_withholding' => true,
'is_public' => true,
'government_affiliated' => true,
'affiliated_entities' => '<string>',
'operations_abroad' => true,
'international_customers_served' => true
]
]),
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/business/{customer_id}"
payload := strings.NewReader("{\n \"business\": {\n \"business_name\": \"<string>\",\n \"dba\": \"<string>\",\n \"naics_code\": 123,\n \"business_description\": \"<string>\",\n \"formation_state\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"ein\": \"<string>\",\n \"business_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"mailing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone\": 123,\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"backup_withholding\": true,\n \"is_public\": true,\n \"government_affiliated\": true,\n \"affiliated_entities\": \"<string>\",\n \"operations_abroad\": true,\n \"international_customers_served\": true\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/business/{customer_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 \"business\": {\n \"business_name\": \"<string>\",\n \"dba\": \"<string>\",\n \"naics_code\": 123,\n \"business_description\": \"<string>\",\n \"formation_state\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"ein\": \"<string>\",\n \"business_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"mailing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone\": 123,\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"backup_withholding\": true,\n \"is_public\": true,\n \"government_affiliated\": true,\n \"affiliated_entities\": \"<string>\",\n \"operations_abroad\": true,\n \"international_customers_served\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/partner/clover/customers/business/{customer_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 \"business\": {\n \"business_name\": \"<string>\",\n \"dba\": \"<string>\",\n \"naics_code\": 123,\n \"business_description\": \"<string>\",\n \"formation_state\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"ein\": \"<string>\",\n \"business_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"mailing_address\": {\n \"street_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"country\": \"<string>\",\n \"street_2\": \"<string>\"\n },\n \"phone\": 123,\n \"email\": \"<string>\",\n \"website\": \"<string>\",\n \"backup_withholding\": true,\n \"is_public\": true,\n \"government_affiliated\": true,\n \"affiliated_entities\": \"<string>\",\n \"operations_abroad\": true,\n \"international_customers_served\": true\n }\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Signature header
Timestamp header
Nonce header
Account ID header
Schema to deserialize the business patch request.
Represent the optional fields for a business update.
Show child attributes
Successful Response
The response is of type Response Update Business Customer Partner Clover Customers Business Customer Id Patch · object.