Frozen v1 · Add address to a debtor - paywise Knowledge Center

Add address to a debtor

import requests

url = "https://api.paywise.de/v1/debtors/{id}/addresses/"

payload = {
    "street": "<string>",
    "zip": "<string>",
    "city": "<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({street: '<string>', zip: '<string>', city: '<string>'})
};

fetch('https://api.paywise.de/v1/debtors/{id}/addresses/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.paywise.de/v1/debtors/{id}/addresses/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"street\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"city\": \"<string>\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/v1/debtors/{id}/addresses/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"street\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"city\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request POST \
  --url https://api.paywise.de/v1/debtors/{id}/addresses/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "street": "<string>",
  "zip": "<string>",
  "city": "<string>"
}
'

{
  "href": "<string>",
  "acting_as": "consumer",
  "addresses": [
    {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "country": "AF"
    }
  ],
  "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": [
    {
      "type": "email",
      "value": "<string>"
    }
  ],
  "bank_accounts": [
    {
      "iban": "<string>",
      "bic": "<string>"
    }
  ],
  "metadata": [
    {
      "type": "user:reference",
      "value": "<string>"
    }
  ],
  "events": [
    {
      "type": "registration",
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ]
}

POST

debtors

{id}

addresses

Add address to a debtor

import requests

url = "https://api.paywise.de/v1/debtors/{id}/addresses/"

payload = {
    "street": "<string>",
    "zip": "<string>",
    "city": "<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({street: '<string>', zip: '<string>', city: '<string>'})
};

fetch('https://api.paywise.de/v1/debtors/{id}/addresses/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.paywise.de/v1/debtors/{id}/addresses/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"street\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"city\": \"<string>\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/v1/debtors/{id}/addresses/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"street\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"city\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request POST \
  --url https://api.paywise.de/v1/debtors/{id}/addresses/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "street": "<string>",
  "zip": "<string>",
  "city": "<string>"
}
'

{
  "href": "<string>",
  "acting_as": "consumer",
  "addresses": [
    {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "country": "AF"
    }
  ],
  "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": [
    {
      "type": "email",
      "value": "<string>"
    }
  ],
  "bank_accounts": [
    {
      "iban": "<string>",
      "bic": "<string>"
    }
  ],
  "metadata": [
    {
      "type": "user:reference",
      "value": "<string>"
    }
  ],
  "events": [
    {
      "type": "registration",
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ]
}

This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.

Autorisierungen

Authorization

string

header

erforderlich

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

Pfadparameter

string

erforderlich

Body

street

string | null

erforderlich

Maximum string length: 255

zip

string | null

erforderlich

Maximum string length: 100

city

string | null

erforderlich

Maximum string length: 100

country

enum<string>

erforderlich

The country, formatted as two letter ISO-3166-1 country code.

AF - Afghanistan
EG - Ägypten
AX - Åland-Inseln
AL - Albanien
DZ - Algerien
AS - Amerikanisch-Samoa
VI - Amerikanische Jungferninseln
AD - Andorra
AO - Angola
AI - Anguilla
AQ - Antarktis
AG - Antigua und Barbuda
GQ - Äquatorialguinea
AR - Argentinien
AM - Armenien
AW - Aruba
AZ - Aserbaidschan
ET - Äthiopien
AU - Australien
BS - Bahamas
BH - Bahrain
BD - Bangladesch
BB - Barbados
BE - Belgien
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivien
BQ - Bonaire, Sint Eustatius und Saba
BA - Bosnien und Herzegowina
BW - Botswana
BV - Bouvetinsel
BR - Brasilien
VG - Britische Jungferninseln
IO - Britisches Territorium im Indischen Ozean
BN - Brunei
BG - Bulgarien
BF - Burkina Faso
BI - Burundi
CL - Chile
CN - China
MP - Commonwealth der Nördlichen Marianen
CK - Cookinseln
CR - Costa Rica
CI - Côte d'Ivoire
CW - Curaçao
DK - Dänemark
DE - Deutschland
DM - Dominica
DO - Dominikanische Republik
DJ - Dschibuti
EC - Ecuador
SV - El Salvador
ER - Eritrea
EE - Estland
FK - Falklandinseln (Malwinen)
FO - Faröerinseln
FJ - Fidschi
FI - Finnland
FR - Frankreich
GF - Französisch Guinea
PF - Französisch-Polynesien
TF - Französische Süd- und Antarktisgebiete
GA - Gabun
GM - Gambia
GE - Georgien
GH - Ghana
GI - Gibraltar
GD - Granada
GR - Griechenland
GL - Grönland
GP - Guadeloupe
GU - Guam
GT - Guatemala
GG - Guernsey
GN - Guinea
GW - Guinea-Bissau
GY - Guyana
HT - Haiti
HM - Heard und McDonaldinseln
HN - Honduras
HK - Hong Kong
IN - Indien
ID - Indonesien
IQ - Irak
IR - Iran
IE - Irland
IS - Island
IM - Isle of Man
IL - Israel
IT - Italien
JM - Jamaika
JP - Japan
YE - Jemen
JE - Jersey
JO - Jordanien
KY - Kaimaninseln
KH - Kambodscha
CM - Kamerun
CA - Kanada
CV - Kap Verde
KZ - Kasachstan
QA - Katar
KE - Kenia
KG - Kirgisistan
KI - Kirivati
CC - Kokosinseln (Keelinginseln)
CO - Kolumbien
KM - Komoren
CG - Kongo
CD - Kongo (Demokratische Republik)
HR - Kroatien
CU - Kuba
KW - Kuwait
LA - Laos
LS - Lesotho
LV - Lettland
LB - Libanon
LR - Liberia
LY - Libyen
LI - Liechtenstein
LT - Litauen
LU - Luxemburg
MO - Macao
MG - Madagaskar
MW - Malawi
MY - Malaysia
MV - Malediven
ML - Mali
MT - Malta
MA - Marokko
MH - Marshallinseln
MQ - Martinique
MR - Mauretanien
MU - Mauritius
YT - Mayotte
MK - Mazedonien
MX - Mexiko
FM - Mikronesien (Föderierte Staaten von)
MD - Moldawien
MC - Monaco
MN - Mongolei
ME - Montenegro
MS - Montserrat
MZ - Mozambique
MM - Myanmar
NA - Namibia
NR - Nauru
NP - Nepal
NC - Neukaledonien
NZ - Neuseeland
NI - Nicaragua
NL - Niederlande
NE - Niger
NG - Nigeria
NU - Niue
KP - Nordkorea
NF - Norfolkinsel
NO - Norwegen
OM - Oman
AT - Österreich
TL - Osttimor
PK - Pakistan
PS - Palästina
PW - Palau
PA - Panama
PG - Papua Neu Guinea
PY - Paraguay
PE - Peru
PH - Philippinen
PN - Pitcairn
PL - Polen
PT - Portugal
PR - Puerto Rico
RE - Réunion
RW - Ruanda
RO - Rumänien
RU - Russland
BL - Saint-Barthélemy
PM - Saint-Pierre und Miquelon
SB - Salomonen
ZM - Sambia
WS - Samoa
SM - San Marino
ST - São Tomé und Príncipe
SA - Saudi Arabien
SE - Schweden
CH - Schweiz
SN - Senegal
RS - Serbien
SC - Seychellen
SL - Sierra Leone
ZW - Simbabwe
SG - Singapur
SX - Sint Maarten (niederländischer Teil)
SK - Slowakei
SI - Slowenien
SO - Somalia
ES - Spanien
SJ - Spitzbergen und Jan Mayen
LK - Sri Lanka
SH - St. Helena, Ascension und Tristan da Cunha
KN - St. Kitts und Nevis
LC - St. Lucia
MF - St. Martin (französischer Teil)
VC - St. Vincent und die Grenadinen
ZA - Südafrika
SD - Sudan
GS - Südgeorgien und die Südlichen Sandwichinseln
KR - Südkorea
SS - Südsudan
SR - Surinam
SZ - Swasiland
SY - Syrien
TJ - Tadschikistan
TW - Taiwan
TZ - Tansania
TH - Thailand
TG - Togo
TK - Tokelau
TO - Tonga
TT - Trinidad und Tobago
TD - Tschad
CZ - Tschechien
TN - Tunesien
TR - Türkei
TM - Turkmenistan
TC - Turks- und Caicosinseln
TV - Tuvalu
UM - USA - Sonstige Kleine Inseln
UG - Uganda
UA - Ukraine
HU - Ungarn
UY - Uruguay
UZ - Usbekistan
VU - Vanuatu
VA - Vatikanstadt
VE - Venezuela
AE - Vereinigte Arabische Emirate
US - Vereinigte Staaten von Amerika
GB - Vereinigtes Königreich
VN - Vietnam
WF - Wallis und Futuna
CX - Weihnachtsinsel
BY - Weißrussland
EH - Westsahara
CF - Zentralafrikanische Republik
CY - Zypern

Verfügbare Optionen:

AF,

EG,

AX,

AL,

DZ,

AS,

VI,

AD,

AO,

AI,

AQ,

AG,

GQ,

AR,

AM,

AW,

AZ,

ET,

AU,

BS,

BH,

BD,

BB,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

VG,

IO,

BN,

BG,

BF,

BI,

CL,

CN,

MP,

CK,

CR,

CI,

CW,

DK,

DE,

DM,

DO,

DJ,

EC,

SV,

ER,

EE,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

GH,

GI,

GD,

GR,

GL,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

HN,

HK,

IN,

ID,

IQ,

IR,

IE,

IS,

IM,

IL,

IT,

JM,

JP,

YE,

JE,

JO,

KY,

KH,

CM,

CA,

CV,

KZ,

QA,

KE,

KG,

KI,

CC,

CO,

KM,

CG,

CD,

HR,

CU,

KW,

LA,

LS,

LV,

LB,

LR,

LY,

LI,

LT,

LU,

MO,

MG,

MW,

MY,

MV,

ML,

MT,

MA,

MH,

MQ,

MR,

MU,

YT,

MK,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MZ,

MM,

NA,

NR,

NP,

NC,

NZ,

NI,

NL,

NE,

NG,

NU,

KP,

NF,

NO,

OM,

AT,

TL,

PK,

PS,

PW,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

RE,

RW,

RO,

RU,

BL,

PM,

SB,

ZM,

WS,

SM,

ST,

SA,

SE,

CH,

SN,

RS,

SC,

SL,

ZW,

SG,

SX,

SK,

SI,

SO,

ES,

SJ,

LK,

SH,

KN,

LC,

MF,

VC,

ZA,

SD,

GS,

KR,

SS,

SR,

SZ,

SY,

TJ,

TW,

TZ,

TH,

TG,

TK,

TO,

TT,

TD,

CZ,

TN,

TR,

TM,

TC,

TV,

UM,

UG,

UA,

HU,

UY,

UZ,

VU,

VA,

VE,

AE,

US,

GB,

VN,

WF,

CX,

BY,

EH,

CF,

CY

Antwort

201 - application/json

href

string<uri>

erforderlich

read-only

acting_as

erforderlich

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

Verfügbare Optionen:

consumer,

business

addresses

object[]

erforderlich

Show child attributes

created

string<date-time>

erforderlich

read-only

updated

string<date-time>

erforderlich

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

Mahnservice

Verwaltung

Frozen v1 · Add address to a debtor

Autorisierungen

Pfadparameter

Body

Antwort