Create a debtor

Create a debtor

curl --request POST \
  --url https://api.paywise.de/v1/debtors/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "addresses": [
    {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>"
    }
  ],
  "your_reference": "<string>",
  "communication_channels": [
    {
      "value": "<string>"
    }
  ],
  "bank_accounts": [
    {
      "iban": "<string>",
      "bic": "<string>"
    }
  ],
  "metadata": [
    {
      "value": "<string>"
    }
  ],
  "events": [
    {
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ]
}
'

import requests

url = "https://api.paywise.de/v1/debtors/"

payload = {
    "addresses": [
        {
            "street": "<string>",
            "zip": "<string>",
            "city": "<string>"
        }
    ],
    "your_reference": "<string>",
    "communication_channels": [{ "value": "<string>" }],
    "bank_accounts": [
        {
            "iban": "<string>",
            "bic": "<string>"
        }
    ],
    "metadata": [{ "value": "<string>" }],
    "events": [
        {
            "title": "<string>",
            "occurence": "2023-11-07T05:31:56Z",
            "your_reference": "<string>",
            "description": "<string>",
            "location": "<string>"
        }
    ]
}
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({
    addresses: [{street: '<string>', zip: '<string>', city: '<string>'}],
    your_reference: '<string>',
    communication_channels: [{value: '<string>'}],
    bank_accounts: [{iban: '<string>', bic: '<string>'}],
    metadata: [{value: '<string>'}],
    events: [
      {
        title: '<string>',
        occurence: '2023-11-07T05:31:56Z',
        your_reference: '<string>',
        description: '<string>',
        location: '<string>'
      }
    ]
  })
};

fetch('https://api.paywise.de/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/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([
    'addresses' => [
        [
                'street' => '<string>',
                'zip' => '<string>',
                'city' => '<string>'
        ]
    ],
    'your_reference' => '<string>',
    'communication_channels' => [
        [
                'value' => '<string>'
        ]
    ],
    'bank_accounts' => [
        [
                'iban' => '<string>',
                'bic' => '<string>'
        ]
    ],
    'metadata' => [
        [
                'value' => '<string>'
        ]
    ],
    'events' => [
        [
                'title' => '<string>',
                'occurence' => '2023-11-07T05:31:56Z',
                'your_reference' => '<string>',
                'description' => '<string>',
                'location' => '<string>'
        ]
    ]
  ]),
  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/v1/debtors/"

	payload := strings.NewReader("{\n  \"addresses\": [\n    {\n      \"street\": \"<string>\",\n      \"zip\": \"<string>\",\n      \"city\": \"<string>\"\n    }\n  ],\n  \"your_reference\": \"<string>\",\n  \"communication_channels\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"bank_accounts\": [\n    {\n      \"iban\": \"<string>\",\n      \"bic\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"title\": \"<string>\",\n      \"occurence\": \"2023-11-07T05:31:56Z\",\n      \"your_reference\": \"<string>\",\n      \"description\": \"<string>\",\n      \"location\": \"<string>\"\n    }\n  ]\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/v1/debtors/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"addresses\": [\n    {\n      \"street\": \"<string>\",\n      \"zip\": \"<string>\",\n      \"city\": \"<string>\"\n    }\n  ],\n  \"your_reference\": \"<string>\",\n  \"communication_channels\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"bank_accounts\": [\n    {\n      \"iban\": \"<string>\",\n      \"bic\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"title\": \"<string>\",\n      \"occurence\": \"2023-11-07T05:31:56Z\",\n      \"your_reference\": \"<string>\",\n      \"description\": \"<string>\",\n      \"location\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywise.de/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  \"addresses\": [\n    {\n      \"street\": \"<string>\",\n      \"zip\": \"<string>\",\n      \"city\": \"<string>\"\n    }\n  ],\n  \"your_reference\": \"<string>\",\n  \"communication_channels\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"bank_accounts\": [\n    {\n      \"iban\": \"<string>\",\n      \"bic\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"title\": \"<string>\",\n      \"occurence\": \"2023-11-07T05:31:56Z\",\n      \"your_reference\": \"<string>\",\n      \"description\": \"<string>\",\n      \"location\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "href": "<string>",
  "addresses": [
    {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "your_reference": "<string>",
  "person": {
    "first_name": "<string>",
    "last_name": "<string>",
    "salutation": "<string>",
    "birth_date": "2023-12-25",
    "death_date": "2023-12-25"
  },
  "organization": {
    "name": "<string>"
  },
  "communication_channels": [
    {
      "value": "<string>"
    }
  ],
  "bank_accounts": [
    {
      "iban": "<string>",
      "bic": "<string>"
    }
  ],
  "metadata": [
    {
      "value": "<string>"
    }
  ],
  "events": [
    {
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ]
}

POST

debtors

Create a debtor

curl --request POST \
  --url https://api.paywise.de/v1/debtors/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "addresses": [
    {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>"
    }
  ],
  "your_reference": "<string>",
  "communication_channels": [
    {
      "value": "<string>"
    }
  ],
  "bank_accounts": [
    {
      "iban": "<string>",
      "bic": "<string>"
    }
  ],
  "metadata": [
    {
      "value": "<string>"
    }
  ],
  "events": [
    {
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ]
}
'

import requests

url = "https://api.paywise.de/v1/debtors/"

payload = {
    "addresses": [
        {
            "street": "<string>",
            "zip": "<string>",
            "city": "<string>"
        }
    ],
    "your_reference": "<string>",
    "communication_channels": [{ "value": "<string>" }],
    "bank_accounts": [
        {
            "iban": "<string>",
            "bic": "<string>"
        }
    ],
    "metadata": [{ "value": "<string>" }],
    "events": [
        {
            "title": "<string>",
            "occurence": "2023-11-07T05:31:56Z",
            "your_reference": "<string>",
            "description": "<string>",
            "location": "<string>"
        }
    ]
}
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({
    addresses: [{street: '<string>', zip: '<string>', city: '<string>'}],
    your_reference: '<string>',
    communication_channels: [{value: '<string>'}],
    bank_accounts: [{iban: '<string>', bic: '<string>'}],
    metadata: [{value: '<string>'}],
    events: [
      {
        title: '<string>',
        occurence: '2023-11-07T05:31:56Z',
        your_reference: '<string>',
        description: '<string>',
        location: '<string>'
      }
    ]
  })
};

fetch('https://api.paywise.de/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/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([
    'addresses' => [
        [
                'street' => '<string>',
                'zip' => '<string>',
                'city' => '<string>'
        ]
    ],
    'your_reference' => '<string>',
    'communication_channels' => [
        [
                'value' => '<string>'
        ]
    ],
    'bank_accounts' => [
        [
                'iban' => '<string>',
                'bic' => '<string>'
        ]
    ],
    'metadata' => [
        [
                'value' => '<string>'
        ]
    ],
    'events' => [
        [
                'title' => '<string>',
                'occurence' => '2023-11-07T05:31:56Z',
                'your_reference' => '<string>',
                'description' => '<string>',
                'location' => '<string>'
        ]
    ]
  ]),
  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/v1/debtors/"

	payload := strings.NewReader("{\n  \"addresses\": [\n    {\n      \"street\": \"<string>\",\n      \"zip\": \"<string>\",\n      \"city\": \"<string>\"\n    }\n  ],\n  \"your_reference\": \"<string>\",\n  \"communication_channels\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"bank_accounts\": [\n    {\n      \"iban\": \"<string>\",\n      \"bic\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"title\": \"<string>\",\n      \"occurence\": \"2023-11-07T05:31:56Z\",\n      \"your_reference\": \"<string>\",\n      \"description\": \"<string>\",\n      \"location\": \"<string>\"\n    }\n  ]\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/v1/debtors/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"addresses\": [\n    {\n      \"street\": \"<string>\",\n      \"zip\": \"<string>\",\n      \"city\": \"<string>\"\n    }\n  ],\n  \"your_reference\": \"<string>\",\n  \"communication_channels\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"bank_accounts\": [\n    {\n      \"iban\": \"<string>\",\n      \"bic\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"title\": \"<string>\",\n      \"occurence\": \"2023-11-07T05:31:56Z\",\n      \"your_reference\": \"<string>\",\n      \"description\": \"<string>\",\n      \"location\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywise.de/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  \"addresses\": [\n    {\n      \"street\": \"<string>\",\n      \"zip\": \"<string>\",\n      \"city\": \"<string>\"\n    }\n  ],\n  \"your_reference\": \"<string>\",\n  \"communication_channels\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"bank_accounts\": [\n    {\n      \"iban\": \"<string>\",\n      \"bic\": \"<string>\"\n    }\n  ],\n  \"metadata\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"title\": \"<string>\",\n      \"occurence\": \"2023-11-07T05:31:56Z\",\n      \"your_reference\": \"<string>\",\n      \"description\": \"<string>\",\n      \"location\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "href": "<string>",
  "addresses": [
    {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "your_reference": "<string>",
  "person": {
    "first_name": "<string>",
    "last_name": "<string>",
    "salutation": "<string>",
    "birth_date": "2023-12-25",
    "death_date": "2023-12-25"
  },
  "organization": {
    "name": "<string>"
  },
  "communication_channels": [
    {
      "value": "<string>"
    }
  ],
  "bank_accounts": [
    {
      "iban": "<string>",
      "bic": "<string>"
    }
  ],
  "metadata": [
    {
      "value": "<string>"
    }
  ],
  "events": [
    {
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

acting_as

required

Tell us if the debtor is either a consumer or a business/other organization. Single-person-business debtors must have the value business

consumer - Verbraucher
business - Unternehmer

Available options:

consumer,

business

addresses

object[]

required

Show child attributes

your_reference

string | null

Maximum string length: 255

person

object

If the debtor is a natural person or a single-person-business please provide this object. In case of a single-person-business, please set acting_as to business

Show child attributes

organization

object

If the debtor is an organization (no single-person-business), please provide this object. For single-person-business debtors see the person field.

Show child attributes

communication_channels

object[]

Show child attributes

bank_accounts

object[]

Show child attributes

metadata

object[]

Show child attributes

events

object[]

Show child attributes

Response

201 - application/json

href

string<uri>

required

read-only

acting_as

required

Tell us if the debtor is either a consumer or a business/other organization. Single-person-business debtors must have the value business

consumer - Verbraucher
business - Unternehmer

Available options:

consumer,

business

addresses

object[]

required

Show child attributes

created

string<date-time>

required

read-only

updated

string<date-time>

required

read-only

string

your_reference

string | null

Maximum string length: 255

person

object

If the debtor is a natural person or a single-person-business please provide this object. In case of a single-person-business, please set acting_as to business

Show child attributes

organization

object

If the debtor is an organization (no single-person-business), please provide this object. For single-person-business debtors see the person field.

Show child attributes

communication_channels

object[]

Show child attributes

bank_accounts

object[]

Show child attributes

metadata

object[]

Show child attributes

events

object[]

Show child attributes

List debtors Retrieve a debtor

Integrations

Case Management API

Partner API

Authorizations

Body

Response