curl --request POST \
--url https://api.augustus.com/v1/counterparties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"financial_address": {
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
},
"name": "<string>",
"date_of_birth": "2023-12-25",
"is_self_owned": false,
"metadata": {
"invoice_id": "INV-2026-0042"
}
}
'import requests
url = "https://api.augustus.com/v1/counterparties"
payload = {
"financial_address": {
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
},
"name": "<string>",
"date_of_birth": "2023-12-25",
"is_self_owned": False,
"metadata": { "invoice_id": "INV-2026-0042" }
}
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({
financial_address: {
type: 'iban',
iban: 'DE89370400440532013000',
account_holder_name: 'Acme Sandbox Ltd.',
bic: 'COBADEFFXXX'
},
name: '<string>',
date_of_birth: '2023-12-25',
is_self_owned: false,
metadata: {invoice_id: 'INV-2026-0042'}
})
};
fetch('https://api.augustus.com/v1/counterparties', 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",
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([
'financial_address' => [
'type' => 'iban',
'iban' => 'DE89370400440532013000',
'account_holder_name' => 'Acme Sandbox Ltd.',
'bic' => 'COBADEFFXXX'
],
'name' => '<string>',
'date_of_birth' => '2023-12-25',
'is_self_owned' => false,
'metadata' => [
'invoice_id' => 'INV-2026-0042'
]
]),
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"
payload := strings.NewReader("{\n \"financial_address\": {\n \"type\": \"iban\",\n \"iban\": \"DE89370400440532013000\",\n \"account_holder_name\": \"Acme Sandbox Ltd.\",\n \"bic\": \"COBADEFFXXX\"\n },\n \"name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": false,\n \"metadata\": {\n \"invoice_id\": \"INV-2026-0042\"\n }\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")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"financial_address\": {\n \"type\": \"iban\",\n \"iban\": \"DE89370400440532013000\",\n \"account_holder_name\": \"Acme Sandbox Ltd.\",\n \"bic\": \"COBADEFFXXX\"\n },\n \"name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": false,\n \"metadata\": {\n \"invoice_id\": \"INV-2026-0042\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/counterparties")
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 \"financial_address\": {\n \"type\": \"iban\",\n \"iban\": \"DE89370400440532013000\",\n \"account_holder_name\": \"Acme Sandbox Ltd.\",\n \"bic\": \"COBADEFFXXX\"\n },\n \"name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": false,\n \"metadata\": {\n \"invoice_id\": \"INV-2026-0042\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "counterparty",
"name": "<string>",
"entity_type": "business",
"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,
"blocked": true,
"metadata": {
"invoice_id": "INV-2026-0042"
}
}Create counterparty
Creates a counterparty owned by the merchant.
curl --request POST \
--url https://api.augustus.com/v1/counterparties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"financial_address": {
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
},
"name": "<string>",
"date_of_birth": "2023-12-25",
"is_self_owned": false,
"metadata": {
"invoice_id": "INV-2026-0042"
}
}
'import requests
url = "https://api.augustus.com/v1/counterparties"
payload = {
"financial_address": {
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
},
"name": "<string>",
"date_of_birth": "2023-12-25",
"is_self_owned": False,
"metadata": { "invoice_id": "INV-2026-0042" }
}
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({
financial_address: {
type: 'iban',
iban: 'DE89370400440532013000',
account_holder_name: 'Acme Sandbox Ltd.',
bic: 'COBADEFFXXX'
},
name: '<string>',
date_of_birth: '2023-12-25',
is_self_owned: false,
metadata: {invoice_id: 'INV-2026-0042'}
})
};
fetch('https://api.augustus.com/v1/counterparties', 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",
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([
'financial_address' => [
'type' => 'iban',
'iban' => 'DE89370400440532013000',
'account_holder_name' => 'Acme Sandbox Ltd.',
'bic' => 'COBADEFFXXX'
],
'name' => '<string>',
'date_of_birth' => '2023-12-25',
'is_self_owned' => false,
'metadata' => [
'invoice_id' => 'INV-2026-0042'
]
]),
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"
payload := strings.NewReader("{\n \"financial_address\": {\n \"type\": \"iban\",\n \"iban\": \"DE89370400440532013000\",\n \"account_holder_name\": \"Acme Sandbox Ltd.\",\n \"bic\": \"COBADEFFXXX\"\n },\n \"name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": false,\n \"metadata\": {\n \"invoice_id\": \"INV-2026-0042\"\n }\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")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"financial_address\": {\n \"type\": \"iban\",\n \"iban\": \"DE89370400440532013000\",\n \"account_holder_name\": \"Acme Sandbox Ltd.\",\n \"bic\": \"COBADEFFXXX\"\n },\n \"name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": false,\n \"metadata\": {\n \"invoice_id\": \"INV-2026-0042\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/counterparties")
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 \"financial_address\": {\n \"type\": \"iban\",\n \"iban\": \"DE89370400440532013000\",\n \"account_holder_name\": \"Acme Sandbox Ltd.\",\n \"bic\": \"COBADEFFXXX\"\n },\n \"name\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"is_self_owned\": false,\n \"metadata\": {\n \"invoice_id\": \"INV-2026-0042\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "counterparty",
"name": "<string>",
"entity_type": "business",
"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,
"blocked": true,
"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.
Body
Counterparty parameters
Financial address of the counterparty.
- IBAN
- UK Sort Code
- ABA
- BIC
- Wallet
Show child attributes
Show child attributes
{
"type": "iban",
"iban": "DE89370400440532013000",
"account_holder_name": "Acme Sandbox Ltd.",
"bic": "COBADEFFXXX"
}
Name of the counterparty.
Physical address of the counterparty.
Show child attributes
Show child attributes
Date of birth in YYYY-MM-DD format.
Whether the counterparty is a business or an individual. Defaults to business.
business, individual Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is.
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
{ "invoice_id": "INV-2026-0042" }
Response
The created counterparty
Unique identifier of the counterparty.
Resource type discriminator.
counterparty Name of the counterparty, or null if not recorded.
Whether the counterparty is a business or an individual.
business, individual 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
- BIC
- 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.
Whether payments to or from this counterparty are currently blocked.
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
{ "invoice_id": "INV-2026-0042" }
Was this page helpful?