Update counterparty
curl --request POST \
--url https://api.augustus.com/v1/counterparties/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "Acme Sandbox Ltd.",
"physical_address": {
"city": "San Francisco",
"country_code": "US",
"line_1": "548 Market St",
"line_2": "Apartment 4B",
"postal_code": "94103",
"state": "CA"
},
"date_of_birth": "1990-01-15",
"phone": "+55 11 91234 5678",
"email": "finance@example.com",
"legal_id": "12.345.678/0001-95",
"is_self_owned": true
}
'import requests
url = "https://api.augustus.com/v1/counterparties/{id}"
payload = {
"name": "Acme Sandbox Ltd.",
"physical_address": {
"city": "San Francisco",
"country_code": "US",
"line_1": "548 Market St",
"line_2": "Apartment 4B",
"postal_code": "94103",
"state": "CA"
},
"date_of_birth": "1990-01-15",
"phone": "+55 11 91234 5678",
"email": "finance@example.com",
"legal_id": "12.345.678/0001-95",
"is_self_owned": True
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Acme Sandbox Ltd.',
physical_address: {
city: 'San Francisco',
country_code: 'US',
line_1: '548 Market St',
line_2: 'Apartment 4B',
postal_code: '94103',
state: 'CA'
},
date_of_birth: '1990-01-15',
phone: '+55 11 91234 5678',
email: 'finance@example.com',
legal_id: '12.345.678/0001-95',
is_self_owned: true
})
};
fetch('https://api.augustus.com/v1/counterparties/{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.augustus.com/v1/counterparties/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Sandbox Ltd.',
'physical_address' => [
'city' => 'San Francisco',
'country_code' => 'US',
'line_1' => '548 Market St',
'line_2' => 'Apartment 4B',
'postal_code' => '94103',
'state' => 'CA'
],
'date_of_birth' => '1990-01-15',
'phone' => '+55 11 91234 5678',
'email' => 'finance@example.com',
'legal_id' => '12.345.678/0001-95',
'is_self_owned' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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 := "https://api.augustus.com/v1/counterparties/{id}"
payload := strings.NewReader("{\n \"name\": \"Acme Sandbox Ltd.\",\n \"physical_address\": {\n \"city\": \"San Francisco\",\n \"country_code\": \"US\",\n \"line_1\": \"548 Market St\",\n \"line_2\": \"Apartment 4B\",\n \"postal_code\": \"94103\",\n \"state\": \"CA\"\n },\n \"date_of_birth\": \"1990-01-15\",\n \"phone\": \"+55 11 91234 5678\",\n \"email\": \"finance@example.com\",\n \"legal_id\": \"12.345.678/0001-95\",\n \"is_self_owned\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-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.post("https://api.augustus.com/v1/counterparties/{id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Sandbox Ltd.\",\n \"physical_address\": {\n \"city\": \"San Francisco\",\n \"country_code\": \"US\",\n \"line_1\": \"548 Market St\",\n \"line_2\": \"Apartment 4B\",\n \"postal_code\": \"94103\",\n \"state\": \"CA\"\n },\n \"date_of_birth\": \"1990-01-15\",\n \"phone\": \"+55 11 91234 5678\",\n \"email\": \"finance@example.com\",\n \"legal_id\": \"12.345.678/0001-95\",\n \"is_self_owned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/counterparties/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Sandbox Ltd.\",\n \"physical_address\": {\n \"city\": \"San Francisco\",\n \"country_code\": \"US\",\n \"line_1\": \"548 Market St\",\n \"line_2\": \"Apartment 4B\",\n \"postal_code\": \"94103\",\n \"state\": \"CA\"\n },\n \"date_of_birth\": \"1990-01-15\",\n \"phone\": \"+55 11 91234 5678\",\n \"email\": \"finance@example.com\",\n \"legal_id\": \"12.345.678/0001-95\",\n \"is_self_owned\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "counterparty",
"name": "Acme Sandbox Ltd.",
"entity_type": "business",
"physical_address": {
"line_1": "548 Market St",
"line_2": "Apartment 4B",
"city": "San Francisco",
"postal_code": "94103",
"state": "CA",
"country_code": "US"
},
"financial_address": {
"type": "aba",
"routing_number": "110000000",
"account_number": "000123456789",
"account_holder_name": "Acme Sandbox Ltd.",
"account_type": "checking"
},
"date_of_birth": "1990-01-15",
"phone": "+55 11 91234 5678",
"email": "finance@example.com",
"legal_id": "12.345.678/0001-95",
"is_self_owned": false,
"blocked": false,
"metadata": {
"invoice_id": "INV-2026-0042"
}
}Counterparties
Update counterparty
Updates the mutable details of a counterparty owned by the merchant.
POST
/
v1
/
counterparties
/
{id}
Update counterparty
curl --request POST \
--url https://api.augustus.com/v1/counterparties/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "Acme Sandbox Ltd.",
"physical_address": {
"city": "San Francisco",
"country_code": "US",
"line_1": "548 Market St",
"line_2": "Apartment 4B",
"postal_code": "94103",
"state": "CA"
},
"date_of_birth": "1990-01-15",
"phone": "+55 11 91234 5678",
"email": "finance@example.com",
"legal_id": "12.345.678/0001-95",
"is_self_owned": true
}
'import requests
url = "https://api.augustus.com/v1/counterparties/{id}"
payload = {
"name": "Acme Sandbox Ltd.",
"physical_address": {
"city": "San Francisco",
"country_code": "US",
"line_1": "548 Market St",
"line_2": "Apartment 4B",
"postal_code": "94103",
"state": "CA"
},
"date_of_birth": "1990-01-15",
"phone": "+55 11 91234 5678",
"email": "finance@example.com",
"legal_id": "12.345.678/0001-95",
"is_self_owned": True
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Acme Sandbox Ltd.',
physical_address: {
city: 'San Francisco',
country_code: 'US',
line_1: '548 Market St',
line_2: 'Apartment 4B',
postal_code: '94103',
state: 'CA'
},
date_of_birth: '1990-01-15',
phone: '+55 11 91234 5678',
email: 'finance@example.com',
legal_id: '12.345.678/0001-95',
is_self_owned: true
})
};
fetch('https://api.augustus.com/v1/counterparties/{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.augustus.com/v1/counterparties/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Sandbox Ltd.',
'physical_address' => [
'city' => 'San Francisco',
'country_code' => 'US',
'line_1' => '548 Market St',
'line_2' => 'Apartment 4B',
'postal_code' => '94103',
'state' => 'CA'
],
'date_of_birth' => '1990-01-15',
'phone' => '+55 11 91234 5678',
'email' => 'finance@example.com',
'legal_id' => '12.345.678/0001-95',
'is_self_owned' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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 := "https://api.augustus.com/v1/counterparties/{id}"
payload := strings.NewReader("{\n \"name\": \"Acme Sandbox Ltd.\",\n \"physical_address\": {\n \"city\": \"San Francisco\",\n \"country_code\": \"US\",\n \"line_1\": \"548 Market St\",\n \"line_2\": \"Apartment 4B\",\n \"postal_code\": \"94103\",\n \"state\": \"CA\"\n },\n \"date_of_birth\": \"1990-01-15\",\n \"phone\": \"+55 11 91234 5678\",\n \"email\": \"finance@example.com\",\n \"legal_id\": \"12.345.678/0001-95\",\n \"is_self_owned\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-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.post("https://api.augustus.com/v1/counterparties/{id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Sandbox Ltd.\",\n \"physical_address\": {\n \"city\": \"San Francisco\",\n \"country_code\": \"US\",\n \"line_1\": \"548 Market St\",\n \"line_2\": \"Apartment 4B\",\n \"postal_code\": \"94103\",\n \"state\": \"CA\"\n },\n \"date_of_birth\": \"1990-01-15\",\n \"phone\": \"+55 11 91234 5678\",\n \"email\": \"finance@example.com\",\n \"legal_id\": \"12.345.678/0001-95\",\n \"is_self_owned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/counterparties/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Sandbox Ltd.\",\n \"physical_address\": {\n \"city\": \"San Francisco\",\n \"country_code\": \"US\",\n \"line_1\": \"548 Market St\",\n \"line_2\": \"Apartment 4B\",\n \"postal_code\": \"94103\",\n \"state\": \"CA\"\n },\n \"date_of_birth\": \"1990-01-15\",\n \"phone\": \"+55 11 91234 5678\",\n \"email\": \"finance@example.com\",\n \"legal_id\": \"12.345.678/0001-95\",\n \"is_self_owned\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "counterparty",
"name": "Acme Sandbox Ltd.",
"entity_type": "business",
"physical_address": {
"line_1": "548 Market St",
"line_2": "Apartment 4B",
"city": "San Francisco",
"postal_code": "94103",
"state": "CA",
"country_code": "US"
},
"financial_address": {
"type": "aba",
"routing_number": "110000000",
"account_number": "000123456789",
"account_holder_name": "Acme Sandbox Ltd.",
"account_type": "checking"
},
"date_of_birth": "1990-01-15",
"phone": "+55 11 91234 5678",
"email": "finance@example.com",
"legal_id": "12.345.678/0001-95",
"is_self_owned": false,
"blocked": false,
"metadata": {
"invoice_id": "INV-2026-0042"
}
}Authorizations
Bearer token for authentication with Augustus Banking API
Headers
Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.
Path Parameters
Unique identifier of the counterparty.
Body
application/json
Counterparty fields to update
New name, or null to clear the current name.
Example:
"Acme Sandbox Ltd."
New physical address, or null to clear the current physical address.
Show child attributes
Show child attributes
New date of birth in YYYY-MM-DD format, or null to clear the current date of birth.
Example:
"1990-01-15"
New phone number, or null to clear the current phone number.
Required string length:
1 - 32Pattern:
^\+?[ ().-]*[0-9][0-9 ().-]*$Example:
"+55 11 91234 5678"
New email address, or null to clear the current email address.
Maximum string length:
254Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Example:
"finance@example.com"
New legal identifier, or null to clear the current legal identifier.
Required string length:
1 - 127Example:
"12.345.678/0001-95"
New entity type. Omit to keep the current entity type.
Available options:
business, individual New ownership status. Omit to keep the current ownership status.
Response
200 - application/json
The updated counterparty
Unique identifier of the counterparty.
Resource type discriminator.
Available options:
counterparty Name of the counterparty, or null if not recorded.
Example:
"Acme Sandbox Ltd."
Whether the counterparty is a business or an individual.
Available options:
business, individual Example:
"business"
Physical address of the counterparty, or null if not recorded.
Show child attributes
Show child attributes
Financial address of the counterparty.
- ABA
- IBAN
- UK Sort Code
- BIC
- Wallet
Show child attributes
Show child attributes
Example:
{
"type": "aba",
"routing_number": "110000000",
"account_number": "000123456789",
"account_holder_name": "Acme Sandbox Ltd.",
"account_type": "checking"
}
Date of birth in YYYY-MM-DD format, or null if not recorded.
Example:
"1990-01-15"
Phone number of the counterparty, or null if not recorded.
Example:
"+55 11 91234 5678"
Email address of the counterparty, or null if not recorded.
Example:
"finance@example.com"
National tax or identity number of the counterparty, or null if not recorded.
Example:
"12.345.678/0001-95"
Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is.
Example:
false
Whether payments to or from this counterparty are currently blocked.
Example:
false
Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.
Show child attributes
Show child attributes
Example:
{ "invoice_id": "INV-2026-0042" }
Was this page helpful?