import Augustus from '@augustusbank/typescript-sdk';
const client = new Augustus({
apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});
const counterparty = await client.counterparties.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(counterparty.id);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": "<string>",
"physical_address": {
"line_1": "<string>",
"line_2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country_code": "DE"
},
"date_of_birth": "2023-12-25",
"is_self_owned": true
}
'import requests
url = "https://api.augustus.com/v1/counterparties/{id}"
payload = {
"name": "<string>",
"physical_address": {
"line_1": "<string>",
"line_2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country_code": "DE"
},
"date_of_birth": "2023-12-25",
"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)<?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' => '<string>',
'physical_address' => [
'line_1' => '<string>',
'line_2' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '<string>',
'country_code' => 'DE'
],
'date_of_birth' => '2023-12-25',
'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\": \"<string>\",\n \"physical_address\": {\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"DE\"\n },\n \"date_of_birth\": \"2023-12-25\",\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\": \"<string>\",\n \"physical_address\": {\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"DE\"\n },\n \"date_of_birth\": \"2023-12-25\",\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\": \"<string>\",\n \"physical_address\": {\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"DE\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "counterparty",
"name": "<string>",
"physical_address": {
"line_1": "<string>",
"line_2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country_code": "DE"
},
"financial_address": {
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
},
"date_of_birth": "2023-12-25",
"is_self_owned": true
}Update counterparty
Updates the mutable details of a counterparty owned by the merchant.
import Augustus from '@augustusbank/typescript-sdk';
const client = new Augustus({
apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});
const counterparty = await client.counterparties.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(counterparty.id);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": "<string>",
"physical_address": {
"line_1": "<string>",
"line_2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country_code": "DE"
},
"date_of_birth": "2023-12-25",
"is_self_owned": true
}
'import requests
url = "https://api.augustus.com/v1/counterparties/{id}"
payload = {
"name": "<string>",
"physical_address": {
"line_1": "<string>",
"line_2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country_code": "DE"
},
"date_of_birth": "2023-12-25",
"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)<?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' => '<string>',
'physical_address' => [
'line_1' => '<string>',
'line_2' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '<string>',
'country_code' => 'DE'
],
'date_of_birth' => '2023-12-25',
'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\": \"<string>\",\n \"physical_address\": {\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"DE\"\n },\n \"date_of_birth\": \"2023-12-25\",\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\": \"<string>\",\n \"physical_address\": {\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"DE\"\n },\n \"date_of_birth\": \"2023-12-25\",\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\": \"<string>\",\n \"physical_address\": {\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"DE\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "counterparty",
"name": "<string>",
"physical_address": {
"line_1": "<string>",
"line_2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>",
"country_code": "DE"
},
"financial_address": {
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
},
"date_of_birth": "2023-12-25",
"is_self_owned": true
}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
Counterparty fields to update
New name, or null to clear the current name.
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.
New ownership status. Omit to keep the current ownership status.
Response
The updated counterparty
Unique identifier of the counterparty.
Resource type discriminator.
counterparty Name of the counterparty, or null if not recorded.
Physical address of the counterparty, or null if not recorded.
Show child attributes
Show child attributes
Financial address of the counterparty.
- IBAN
- UK Sort Code
- ABA
- Wallet
Show child attributes
Show child attributes
{
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
}
Date of birth in YYYY-MM-DD format, or null if not recorded.
Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is.
Was this page helpful?