Create a debtor
curl --request POST \
--url https://api.paywise.de/mahnservice/v1/debtors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "company",
"customer_number": "<string>",
"email": "[email protected]"
}
'import requests
url = "https://api.paywise.de/mahnservice/v1/debtors/"
payload = {
"name": "<string>",
"type": "company",
"customer_number": "<string>",
"email": "[email protected]"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'company',
customer_number: '<string>',
email: '[email protected]'
})
};
fetch('https://api.paywise.de/mahnservice/v1/debtors/', 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.paywise.de/mahnservice/v1/debtors/",
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>',
'type' => 'company',
'customer_number' => '<string>',
'email' => '[email protected]'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.paywise.de/mahnservice/v1/debtors/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"customer_number\": \"<string>\",\n \"email\": \"[email protected]\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.paywise.de/mahnservice/v1/debtors/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"customer_number\": \"<string>\",\n \"email\": \"[email protected]\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywise.de/mahnservice/v1/debtors/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"customer_number\": \"<string>\",\n \"email\": \"[email protected]\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"access_mode": "test",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"type": "company",
"customer_number": "<string>",
"email": "[email protected]",
"address": {
"street": "<string>",
"zip_code": "<string>",
"city": "<string>",
"country": "DE"
}
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Debtors
Create a debtor
Creates a new debtor on every call; this operation is not idempotent. Store the returned UUID for reuse. List debtors with customer_number and/or email to find existing matches first; neither field is unique and lookup does not prevent concurrent duplicate creates.
POST
/
mahnservice
/
v1
/
debtors
/
Create a debtor
curl --request POST \
--url https://api.paywise.de/mahnservice/v1/debtors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "company",
"customer_number": "<string>",
"email": "[email protected]"
}
'import requests
url = "https://api.paywise.de/mahnservice/v1/debtors/"
payload = {
"name": "<string>",
"type": "company",
"customer_number": "<string>",
"email": "[email protected]"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'company',
customer_number: '<string>',
email: '[email protected]'
})
};
fetch('https://api.paywise.de/mahnservice/v1/debtors/', 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.paywise.de/mahnservice/v1/debtors/",
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>',
'type' => 'company',
'customer_number' => '<string>',
'email' => '[email protected]'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.paywise.de/mahnservice/v1/debtors/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"customer_number\": \"<string>\",\n \"email\": \"[email protected]\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.paywise.de/mahnservice/v1/debtors/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"customer_number\": \"<string>\",\n \"email\": \"[email protected]\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywise.de/mahnservice/v1/debtors/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"company\",\n \"customer_number\": \"<string>\",\n \"email\": \"[email protected]\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"access_mode": "test",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"type": "company",
"customer_number": "<string>",
"email": "[email protected]",
"address": {
"street": "<string>",
"zip_code": "<string>",
"city": "<string>",
"country": "DE"
}
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Draft documentation — API not yet rolled out. This endpoint describes the preview contract and may change before release. Sandbox access is provided separately. See access and limitations.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
A Mahnservice debtor. Create it with a name and an optional email and address; those become the debtor's contact channels for dunning. The access mode and the owning company are taken from the token, never the payload, so a legacy test-mode token can only create test debtors.
Required string length:
1 - 255Whether the debtor is a private person (person) or an organization (company). Defaults to company when omitted during creation.
Available options:
person, company Your customer number for this debtor. Optional and not unique; debtor creation always creates a new record. Use the debtor list customer_number filter to look up existing records.
Maximum string length:
50Primary email address used for dunning notices. Omit or set null to create the debtor without an email contact.
Required string length:
1 - 254Postal address for dunning letters. Optional as a whole; when present, street, zip_code and city are all required.
Show child attributes
Show child attributes
Response
A Mahnservice debtor. Create it with a name and an optional email and address; those become the debtor's contact channels for dunning. The access mode and the owning company are taken from the token, never the payload, so a legacy test-mode token can only create test debtors.
Maximum string length:
255Legacy data-isolation mode inherited from the creating token. Modern credentials use production in both production and sandbox; this field does not select the API environment.
Available options:
test, production Whether the debtor is a private person (person) or an organization (company). Defaults to company when omitted during creation.
Available options:
person, company Your customer number for this debtor. Optional and not unique; debtor creation always creates a new record. Use the debtor list customer_number filter to look up existing records.
Maximum string length:
50Primary email address used for dunning notices. Null when no primary email is recorded.
Maximum string length:
254Postal address for dunning letters. Missing street, postal code and city values are returned as empty strings.
Show child attributes
Show child attributes